.. image:: ../logo.png

.. _CoReCon:

CoReCon: open Collection of Reionization Constraints
====================================================


**CoReCon** is an open collection of constraints on various physical
quantities linked to the *Epoch of Reionization (EoR)*.

It is built to be easily complemented by contribution from the scientific
community, thanks to a simple data form that supports two different ways of 
input data.

CoReCon takes care of loading and interpreting the data, and presenting them 
in an organic and ready-to-use way. It also implement simple slicing capabilities,
which allow to perform simple data filtering.


.. _UsingCoReCon:

Using CoReCon
^^^^^^^^^^^^^

Installation
""""""""""""
CoReCon is still in the beta-testing phase. If you want to try it out, 
it can be installed as a python module, using:

.. code-block:: bash

    pip install corecon

Tutorial
""""""""
For an introduction on how to use CoReCon, check :ref:`Tutorial`.

.. _FunctionDocs:

Function Docs
"""""""""""""
The documentation for CoReCon public functions can be found at :ref:`FunctionsDocs`.


.. _AvailableCoinstraints:

Available constraints
^^^^^^^^^^^^^^^^^^^^^
Click to see more details.

.. include:: _fields_list_.rst


.. _AddYourConstraint:

Adding your constraint
""""""""""""""""""""""
CoReCon has been developed with in mind the contribution from the community. In order 
to add a constraint to the available one, we provide an empty :ref:`DataEntryTemplate`.

In order to make your new constraint available to the community, you can submit a pull 
request to the CoReCon repository_ or simply send it via email to the code author.

.. _repository: https://github.com/EGaraldi/corecon


Reporting issues and contributing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you find any issue with this module, please use the issues_ tracker. 

You can contribute via the repository_.

.. _issues: https://github.com/EGaraldi/corecon/issues


.. _Author:

Author
^^^^^^
Enrico Garaldi
 |  Post-doctoral fellow, 
 |  Institute for Fundamental Physics of the Universe,
 |  Trieste, Italy
 |  email: egaraldi ~at~ sissa ~dot~ it


.. _Contributors:

Contributors
^^^^^^^^^^^^
- Enrico Garaldi
- Marina Ventikos
- Aniket Bhagwat
- Arghyadeep Basu

.. toctree::
  :hidden:
  :maxdepth: 3

  index