.. Virus Health Check documentation master file, created by
   sphinx-quickstart on Tue Mar  3 15:42:41 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Virus Health Check's documentation!
==============================================

Version: |release|

The Virus Health Check (VHC) software checks the health and correctness of the
`fits files <http://fits.gsfc.nasa.gov/fits_home.html>`_ created during
`Hobby-Eberly Telescope (HET)
<http://www.as.utexas.edu/mcdonald/het/het.html>`_ observations. The software is created
specifically for `HET Dark Energy Experiment (HETDEX) <http://hetdex.org>`_, but
it has been designed to be extended to other user cases.

``VHC`` is written in python and supports at least python 2.7 and 3.4.


This documentation is also available on `vhc.readthedocs.io
<https://vhc.readthedocs.io>`_.

.. image:: https://readthedocs.org/projects/vhc/badge/?version=latest
    :target: https://vhc.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

This documentation describes how to use VHC, the design behind it, how
to contribute to it and which checks are already implemented. The structure of
the documentation is the following:

* :ref:`use`. 
* :ref:`develop`
* :ref:`about`

.. _use:

Use the code
------------
.. toctree::
    :maxdepth: 2

    install
    cmdline
    configuration
    dirstruct
    collate_html

.. _drivers:

Implemented Drivers
-------------------

.. toctree::
    :maxdepth: 2

    drivers
    recipes
    
.. _develop:

Develop
-------

.. toctree::
    :maxdepth: 2

    custom_drivers
    contributions
    extend
    codedoc/index

.. _about:

About
-----
.. toctree::
    :maxdepth: 1
    :titlesonly:

    license
    authors
    release_notes
    changelog
    todos

Copyright notice
----------------

Copyright (c)  2018  "The HETDEX collaboration".

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled :ref:`doc_license`.


Indices and tables
~~~~~~~~~~~~~~~~~~

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