.. persephone documentation master file, created by
   sphinx-quickstart on Sat Aug 19 11:14:31 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

persephone: stellar modelling and asteroseismology
==================================================

``persephone`` implements a Python interface to compute
`MESA <https://docs.mesastar.org/en/stable/#>`__ stellar
model grids and run `GYRE <https://gyre.readthedocs.io/en/stable/index.html>`__
on them. It also provides a set of functions to compute seismic kernels.

Please note that the module is still at a development level and some
features are experimental or not mature yet. Do not hesitate to open
issues on the repositoy if you have any suggestions or if there are
aspects that you would like to see added/improved.

Contact address: sylvain.breton@inaf.it

Documentation
#############

.. toctree::
   :maxdepth: 1
   :caption: User guide:

   usage/installation
   usage/quickstart/quickstart
   usage/kernel_tutorial/kernel_tutorial
   usage/acknowledging

.. toctree::
   :maxdepth: 1
   :caption: Detailed API:

   usage/grids/grids
   usage/kernels/kernels
   usage/inversion/inversion