.. peebee documentation master file, created by
   sphinx-quickstart on Thu Feb 22 11:23:39 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

peebee
==================================

.. sidebar-links::
   Index <https://peebee.readthedocs.io/en/latest/genindex.html>
   Tutorials <https://peebee.readthedocs.io/en/latest/tutorialsindex.html>
   GitHub Repository <https://github.com/thomasdonlon/peebee>

.. rubric:: Galactic Dynamics Meets Pulsar Accelerations

HEADS UP: This documentation is currently under heavy development. 

----------------------------------

Tutorials:
----------------------------------

.. toctree::
   :maxdepth: 1

   calculating_accels
   building_a_model
   sampling_from_a_model
   inference
   noise_models

.. :ref:`tutorialsindex`

Content:
----------------------------------

.. toctree::
   :maxdepth: 1
   :caption: Submodules:

   models
   utils
   transforms
   optimize
   sampling
   noise
   accels
   
.. :ref:`genindex`