.. OCD documentation master file, created by
   sphinx-quickstart on Thu Apr 27 17:52:00 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to OCD's documentation!
===============================

The Observation Condition Decision tool (OCD) monitors the Telescope Control
System (TCS) and uses some of the information to decide the next observation.

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

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

Installation and usage
----------------------

.. toctree::
    :maxdepth: 2

    install
    ocd_executables
    ocd_inputs
    ocd_notes
    ocd_decision


Contributions and development
-----------------------------

.. toctree::
    :maxdepth: 2

    contributions

Code documentation
..................

.. toctree::
    :maxdepth: 2

    allow_hetdex
    auto_schedule
    config
    db_replay
    docker_mysql
    errors
    heart_beat
    main
    orchestrator
    run_shot
    shot_db
    states
    storage
    utils

About
-----

.. toctree::
    :maxdepth: 1

    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`