.. reggae documentation master file, created by
   sphinx-quickstart on Wed May  1 06:14:41 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Reggae: Dipole Modes from PBJam
==================================

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   installation
   usage
   quickstart

.. include:: ../README.md
   :parser: myst_parser.sphinx_
   :start-after: <!-- index.rst blurb start -->
   :end-before: <!-- index.rst blurb end -->

Mode Identification
-------------------

The key task that Reggae is intended to perform is mode identification: specifically, assigning mixing fractions and radial orders to dipole mixed gravitoacoustic modes.

.. include:: ../README.md
   :parser: myst_parser.sphinx_
   :start-after: <!-- index.rst science start -->
   :end-before: <!-- index.rst science end -->

This description of the mixed mode frequencies is used to construct models of the power spectral density, from which constraints on its parameters may be derived. For the purpose of assisting in this task, we moreover implement a GUI console.

Contributing
------------

.. include:: ../README.md
   :parser: myst_parser.sphinx_
   :start-after: <!-- index.rst contributing start -->
   :end-before: <!-- index.rst contributing end -->

Indices
-------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`