.. obscurae documentation master file, created by
   sphinx-quickstart on Tue Nov  7 20:23:38 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to obscurae's documentation!
====================================

Have you ever had a stupid planet passing in front of your star and ruining your
stellar line profiles? Well, I have. And I'm tired of it. So I made this package
to help me get rid of those pesky planets.

The same thing goes for stellar spots, also known as stellar impurities.

The planetary shadow is modelled following the approaches in :cite:t:`Albrecht2007,Albrecht2013`, but specifically implemented as described in :cite:t:`Knudstrup2022`.


.. toctree::
   :maxdepth: 1
   :caption: The RM effect

   rm

.. toctree::
   :maxdepth: 1
   :caption: Examples
   
   examples/make_a_star
   examples/meddling_planet
   examples/stellar_impurities

.. toctree::
   :maxdepth: 1
   :caption: Installation

   install

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

   API/shadow
   API/dynamics

.. toctree::
   :maxdepth: 1
   :caption: References

   references

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

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