mascaret: an equatorial model for stellar oscillations
======================================================

The present module includes a complete API to complete
stellar oscillation eigenmodes accounting for rotation
in an equatorial model approximation.

Contact address: sylvain.breton@inaf.it

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

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

   usage/installation/installation
   usage/quickstart/quickstart

.. toctree::
   :maxdepth: 2
   :caption: Detailed API

   usage/api/stellar_model
   usage/api/mode_search
   usage/api/io