.. 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/release-r23.05.1/#>`__ 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.
In the future, inversion methods will be implemented in the module.

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