.. runMACS documentation master file, created by
   sphinx-quickstart on Mon Sep 16 12:34:19 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to runMACS's documentation!
===================================

runMACS is the software package, used to capture and work with data of the Munich Aerosol Cloud Scanner.

runMACS is mostly written in Python 2.7, with data intensive parts of the acquisition written in C++11.
All Python programs can be found under the package/subfolder ``runmacs``, while the C++ part is separated under ``cpp``.
This documentation will concentrate on the Python part, the C++ documentation can be found `here <_static/cppdoc/index.html>`_.

Test coverage information is available `here <_static/python_coverage/index.html>`_.

In the toplevel package folder (``runmacs``), the following subpackages can be found:

* :doc:`spec` - spectrometer specific code
* :doc:`mira` - radar specific code
* :doc:`rtm` - radiative transfer modelling and retrieval
* :doc:`campas` - campaign assistant (scripting language for automated measurements)
* :doc:`processor` - post-processing (== macsServer)
* :doc:`roc` - remote object call (communication library, usesd for all communications during data acquisition)
* :doc:`geometry` - tools for calculations with many coordinate frames
* :doc:`mock` - mock-up object, only used for testing

Furthermore, there is the ``test`` folder, outside of the ``runmacs``-Package, which contains unittests for the Python code.

Contents
--------

.. toctree::
   :maxdepth: 2
   
   cookbook
   modules
   cpp

Indices and tables
------------------

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