.. CBR_CrossCorr documentation master file, created by
   sphinx-quickstart on Sun Nov 24 15:10:31 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

#################################################
Cosmic Microwave Foregrounds (CMFG) documentation
#################################################
 
 
The purpose of this project is to compute the cross correlations between selected centers and the cosmic background radiation.

Project by Heliana Luparello, Diego Garcia Lambas, Ezequiel Boero & Marcelo Lares


A python virtual environment is suggested to work with this project.
Requirements are listed in the project home directory file:
``requirements.txt``.


***************
Science case
***************

.. toctree::
   :maxdepth: 2

   sci/proposal
   sci/references

***************
Getting Started
***************

.. toctree::
   :maxdepth: 2

   api/gettingstarted
   api/usage
   api/description
   api/parsing
   api/visualization
   api/optimizations

*******************
Module description
*******************

.. toctree::
   :maxdepth: 2

   api/parser
   api/cmfg
   api/pixelsky
   api/process
   api/run_experiment
   api/test

***********************
Developer Documentation
***********************

.. toctree::
   :maxdepth: 2

   api/todo
   api/testing
   api/documenting
   api/src_EB
   api/src_HL
   api/src_ML


******************
Indices and tables
******************

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