.. VDAT: Virus Data Analysis Tool documentation master file, created by
   sphinx-quickstart on Thu Jun 11 17:58:50 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to VDAT: Virus Data Analysis Tool's documentation!
==========================================================

Version: |release|

The Virus Data Analysis Tool (VDAT) software is a GUI tool to reduce data from
`Hobby-Eberly Telescope (HET)
<http://www.as.utexas.edu/mcdonald/het/het.html>`_ observations.  The software
is being created specifically for `HET Dark Energy Experiment (HETDEX)
<http://hetdex.org>`_, but we try to design it to be easily extended to other
user cases.

``vdat`` supports python 2.7, 3.4 or later.

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

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

User documentation
------------------
.. toctree::
    :maxdepth: 2

    install
    launching
    dirstruct
    gui/index
    command_interpreter
    FAQ <faq>

.. todo::
    
    Add some instruction about the loggers settings

Developer documentation
-----------------------

.. toctree::
    :maxdepth: 2

    contributions
    codedoc/index


About
-----

.. toctree::
    :maxdepth: 2
    
    license
    authors
    release_notes
    changelog
    todo

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`.

Artwork copyright
-----------------

.. raw:: html

    <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc/4.0/88x31.png" /></a><br />
    <span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/StillImage" property="dct:title" rel="dct:type">VDAT artwork</span> by <span xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">Majo Buro</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial 4.0 International License</a>.

The artwork consists of:

* the logo with the ``VDAT`` text shown in upper left corner of the
  documentation;
* the two splash screens visible when starting VDAT;
* the VDAT window icon.

Links
-----

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