Welcome to the mirar documentation!
=======================================

`mirar <https://github.com/winter-telescope/mirar>`_ is a modular, flexible, open-source code to reduce analyse and astronomy images, built using python 3.10.
It was created by `Robert Stein <https://robertdstein.github.io/>`_ and
`Viraj Karambelkar <https://github.com/virajkaram>`_ (see everyone who contributed at :doc:`contributors`).

* How does mirar work? Check out :doc:`about`.
* How is mirar designed? See :doc:`design`.
* How can you install mirar? You can find instructions at :doc:`installation`.
* How can you use mirar? Have a look at :doc:`usage`, where there is a guide with examples.
* Want to use mirar for your own telescope? Great! Have a look at our :doc:`contributing-guide`. This also describes what to do if you find a bug or want to request a new feature.
* What does x piece of mirar do? See the full documentation at :doc:`modules`.
* Want to which configurations are available for a pipeline, and what they do? Check out :doc:`autogen/pipelines`.

If you make use of mirar in your research, please cite the version using
the DOI provided by Zenodo:

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10888436.svg
  :target: https://doi.org/10.5281/zenodo.10888436


Contents
--------

.. toctree::
    :maxdepth: 2

    about
    installation
    design
    usage
    contributors
    contributing-guide

.. toctree::
    :maxdepth: 3

    autogen/pipelines
    modules

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

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