.. Astrotools documentation

Welcome to the documentation of the astrotools!
===============================================

This documentation describes all functionality implemented in the astrotools.
The astrotools are a lightweight python library for physics of Ultra-high energy
cosmic rays with particular focus on arrival direction tasks. We support
functionalities in the following fields:

* Coordinate transformations
* Cosmic Ray Observables
* Galactic magnetic field lensing
* Setup simulations of arrival scenarios
* Tools for the Pierre Auger Observatory

Repository:
===========
The official repository of the astrotools is on the Gitlab server of the RWTH
Aachen University (use this link for opening issues and pushing code):
https://git.rwth-aachen.de/astro/astrotools

The astrotools are aslo mirrored to Gitlab:
https://gitlab.com/MWirtz/astrotools

Contents:
=========
.. toctree::
  :maxdepth: 2

  tutorial
  installation
  modules


Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`