.. title:: API guide

API Overview
------------
.. toctree::
   :hidden:
   
   XICRA.rst
   modules/modules_index.rst
   
.. 
.. TODO
..   scripts/scripts_index.rst
..   other_tools.rst
..   data.rst
..   third_party.rst
..
   

.. only:: html

    :Version: |version|
    :Date: |today|

Here we include and API_ documentation for ``XICRA`` in order to provide third parties to use the 
functionality of ``XICRA`` application.

This pipeline is composed of multiple modules and scripts that are separated in a main script:

- ``XICRA.py``

This main script integrates and connects all available modules and analysis arranged in 
several directories:

..
.. TODO: review this, other tools? data? also in contents
..

- ``XICRA/modules``
- ``XICRA/scripts``
- ``XICRA/data``
- ``XICRA/other_tools``
- ``XICRA/config``


Contents
^^^^^^^^

XX

.. toctree::
   :maxdepth: 2

   XICRA.rst
   modules/modules_index.rst
   
.. 
.. TODO
..   scripts/scripts_index.rst
..   config/config_index.rst
..   other_tools.rst
..   data.rst
..
   
 
.. ############ 
.. include:: ../links.inc