.. PyGRO documentation master file, created by
   sphinx-quickstart on Mon Feb  7 16:24:07 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PyGRO's documentation!
=================================

PyGRO [pronounced /'pi.gro/, from the italian **pigro**: *lazy*] is a Python library that provides methods and functions to perform the numerical integration of the geodesic equations describing a particle or photon orbit in any metric theory of gravity, given an analytic expression of the metric tensor.


Check out the :doc:`installation` section for getting started.

.. toctree::
   :maxdepth: 2
   :caption: Tutorials:

   installation
   create_metric
   integrate_geodesic
   visualize
   


.. toctree::
   :maxdepth: 2
   :caption: API:

   metricengine
   geodesicengine
   geodesic
   integrators



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

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