.. celmech documentation master file, created by
   sphinx-quickstart on Thu May  7 09:36:06 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome
=======

``celmech`` is a Python package containing a variety of numerical tools for celestial mechanics and dynamical astronomy.
The package is designed to interface closely with the `REBOUND <https://rebound.readthedocs.io/en/latest/>`_ N-body integrator.


Getting Started!
----------------

``celmech`` is written in Python (with some C source code).  For instructions on installation, see :ref:`install`. 
You can then check out :ref:`first_example`. 
You may also want to check out the `Git repository <https://github.com/shadden/celmech/>`_ and its Jupyter notebook examples under celmech/ipython_examples. 


.. toctree::
    :numbered:
    :hidden:
    :maxdepth: 2

    quickstart
    poincare
    disturbing_function
    hamiltonian
    canonical_transformations
    secular
    numerical_resonance_models   
    andoyer
    maps
    nbody_simulation_utilities
    miscellaneous