celeries documentation
======================

celeries (celestial mechanics series) is a computer algebra
package dedicated to celestial mechanics and inspired by
`TRIP <https://www.imcce.fr/trip/>`_.
celeries includes a general framework to perform series expansion in python
(:doc:`_autosummary/celeries.series`),
algorithms for the computation of the N-body Hamiltonian
(:doc:`_autosummary/celeries.perham`),
following [1]_, [2]_,
and specific methods to study mean-motion resonances and resonant chains
(:doc:`_autosummary/celeries.mmr`),
following [3]_.

Please cite [3]_ if you use celeries in a publication.

Installation
------------

Using conda
~~~~~~~~~~~

The celeries package can be installed using conda with the following command:

``conda install -c conda-forge celeries``

Using pip
~~~~~~~~~

It can also be installed using pip with:

``pip install celeries``

Notebook examples
-----------------

.. toctree::
   :maxdepth: 1

   chain_equilibria

API Reference
-------------

.. autosummary::
   :toctree: _autosummary
   :template: autosummary/custom_module.rst
   :recursive:

   celeries.series
   celeries.perham
   celeries.perham3pla
   celeries.mmr
   celeries.birkhoff
   celeries.ellipseries
   celeries.laplace
   celeries.mpfrac
   celeries.prime

References
----------

.. [1] `Laskar & Robutel, "Stability of the Planetary Three-Body Problem. I. Expansion of the Planetary Hamiltonian", 1995 <https://ui.adsabs.harvard.edu/abs/1995CeMDA..62..193L>`_.
.. [2] `Robutel & Pousse, "On the co-orbital motion of two planets in quasi-circular orbits", 2013 <https://ui.adsabs.harvard.edu/abs/2013CeMDA.117...17R>`_.
.. [3] `Delisle, "Analytical model of multi-planetary resonant chains and constraints on migration scenarios", 2017 <https://ui.adsabs.harvard.edu/abs/2017A&A...605A..96D>`_.