.. image:: assets/logo.svg
    :alt: gadfly logo
    :width: 200
    :align: right

gadfly
======

This is the documentation for ``gadfly``, a Python package for generating photometry of
stars with granulation and p-mode oscillations. The source code is available
`on GitHub <https://github.com/bmorris3/gadfly>`_.

.. note::

    ``gadfly`` is under active development. If you run into any issues, please `let us
    know on GitHub <https://github.com/bmorris3/gadfly/issues>`_.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   gadfly/install.rst
   gadfly/start.rst
   gadfly/validation.rst
   gadfly/synth.rst
   gadfly/power_spectra.rst
   gadfly/reference.rst


Indices and tables
==================

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