.. MCS documentation master file, created by
   sphinx-quickstart on Thu Nov 28 13:11:01 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

MIMA Control Software Documentation
===================================

:Release: |version|

:Date: |today|

.. warning::

    1. This "Documentation" is still a work in progress; some of the material
    is not organized, and several aspects of MCS are not yet covered
    with sufficient detail.
    
    2. While every precaution has been taken in the development of MCS software 
    and in the preparation of the documentation, the author assumes no responsibility 
    for errors or omissions, or for damage resulting from the use of the software or of 
    the information contained in the documentation. 



About MIMA
----------

The **Multi-spectral Imager of Mesopause Airglow** (MIMA_) instrument is a 
portable round based image (2D) VIS-NIR spectrometrer with 5 channels for 
long long-term monitoring of mesopause change. The control system is done 
by the MCS application, the MIMA instrument Control Software, which provides:


* a powerful interactive GUI for the automated and remote control of the
  MIMA instrument, fully developed in Python language.

* and a quick data processing tool thanks to the support of `IPython`
  (enhanced interactive Python interpreter) and popular Python libraries
  such as `NumPy` (linear algebra), `SciPy` (signal and image processing)
  or `matplotlib` (interactive 2D/3D plotting) and `scikit_image`_.

The MIMA instrument, based upon a well proven concept of the instrument SATI
currently working at OSN, is a portable round based image (2D) VIS-NIR
spectrometrer with 5 channels for long long-term monitoring of mesopause
change. Completely designed by IAA engineers in collaboration with the
York University along 2017-2019.


MCS links
^^^^^^^^^

* Downloads, bug reports and feature requests: https://github.com/ppmim/MIMA
* Instrument info: http://gapt.iaa.es/content/mima
* In addition to this html version of the manual, there is also a pdf_ version to download.

Contents
--------

.. toctree::
   :maxdepth: 3
   :caption: Getting Started

   installation/install.rst
   getting_started/index.rst
   
.. toctree::
   :maxdepth: 3
   :caption: User Guide

   gui/index.rst
   data_processing/index.rst
   
.. toctree::
   :maxdepth: 3
   :caption: Developer Guide

   developer_guide/index.rst


.. toctree::
   :caption: About
   :maxdepth: 1

   faqs/FAQ.rst
   acronyms.rst
   authors.rst
   changelog.rst
   acknowledgement.rst
   reference.rst
   license.rst
   


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

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

.. links:
.. |logo| image:: _static/mima_logo.png
          :width: 132 px
          :alt: MIMA icon

.. _MIMA: http://gapt.iaa.es/content/mima
.. _OSN: http://www.osn.iaa.es
.. _iaa_web: http://www.iaa.es
.. _source code: http://github.com/ppmim/MCS
.. _documentation: http://www.iaa.es/~jmiguel/MCS/html/index.html
.. _SciPy: http://www.scipy.org
.. _PyFITS: http://www.stsci.edu/resources/software_hardware/pyfits
.. _PyRAF: http://www.stsci.edu/institute/software_hardware/pyraf
.. _PyQt5: http://www.riverbankcomputing.co.uk/software/pyqt/download
.. _Astropy: http://www.astropy.org/
.. _Sphinx: http://sphinx-doc.org/
.. _Anaconda: https://www.anaconda.com/
.. _scikit_image: https://scikit-image.org/
.. _pdf: https://www.iaa.csic.es/~jmiguel/MCS/mcs.pdf