.. QACITS documentation master file, created by
   sphinx-quickstart on Tue Jul 12 10:57:13 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to QACITS's documentation!
==================================
As-built documentation of QACITS modules, utilities, and notebooks. This 
documentation is written using Sphinx.

Credits
--------

This QACITS package was written by Christian Delacroix, with contributions from 
Olivier Absil, Elsa Huby, and Anne-Lise Maire.

The QACITS method is an original idea from Elsa Huby.

For further information, please see the following papers:

* `Huby et al. 2015 <https://www.aanda.org/articles/aa/full_html/2015/12/aa27102-15/aa27102-15.html>`_, Post-coronagraphic tip-tilt sensing for vortex phase masks: The QACITS technique
* `Huby et al. 2017 <https://www.aanda.org/articles/aa/full_html/2017/04/aa30232-16/aa30232-16.html>`_, On-sky performance of the QACITS pointing control technique with the Keck/NIRC2 vortex coronagraph
* `Maire et al. 2020 <https://www.spiedigitallibrary.org/journals/Journal-of-Astronomical-Telescopes-Instruments-and-Systems/volume-6/issue-3/035003/Design-pointing-control-and-on-sky-performance-of-the-mid/10.1117/1.JATIS.6.3.035003.full>`_, Design, pointing control, and on-sky performance of the mid-infrared vortex coronagraph for the VLT/NEAR experiment

Contents
------------

.. toctree::
   :maxdepth: 4
   
   install
   demo
   QACITS



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

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