.. pyigm documentation master file, created by
   sphinx-quickstart on Sat Dec  5 06:40:37 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pyigm's documentation!
=================================

pyigm is an astropy-affiliated package developed to provide software
useful for research on the Intergalactic Medium (IGM).
Its core developers work primarily on absorption-line research with
emphasis on the IGM and related areas.

Contents:
+++++++++

**Overview**

.. toctree::
   :maxdepth: 1

   install
   misc
   api

**IGM/CGM Datasets**

.. toctree::
   :maxdepth: 1

   CGM (e.g. LCO, COS-Halos, COS-Dwarfs) <cgm>
   IGMSurvey (DLA, LLS) <igmsurvey>

**Core classes**

.. toctree::
   :maxdepth: 1

   CGM <cgm>
   CUBA <cuba>
   fN <fn>
   IGMGalaxyField <igmfield>
   IGMSystem <igmsys>
   IGMSurvey <igmsurvey>
   MetallicityPDF <metallicity>

..
   To be added:

**IGM/CGM Surveys**

.. toctree::
   :maxdepth: 1
   COS-Halos <https://github.com/pyigm/pyigm/blob/master/docs/datasets/COS_Halos_Examples.ipynb>
   DLA <https://github.com/pyigm/pyigm/blob/master/docs/datasets/DLASurvey_examples.ipynb>
   LLS <https://github.com/pyigm/pyigm/blob/master/docs/datasets/LLSSurvey_examples.ipynb>

**GUIs**

.. toctree::
   :maxdepth: 1

      IGMGuesses <igmguesses>
      XFitDLA <fitdla>
      XFitLLS <fitlls>


**Misc**

.. toctree::
   :maxdepth: 1

   Continuum <continuum>
   Scripts <scripts>

..
   **Project details**

   .. toctree::
      :maxdepth: 1

      whatsnew
      credits
      license

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

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