================================
MCCS LMC Prototype documentation
================================

This project is developing the Local Monitoring and Control (LMC)
prototype for the `Square Kilometre Array`_.

.. _Square Kilometre Array: https://skatelescope.org/

.. toctree::
   :maxdepth: 1
   :caption: Getting started

   getting_started/getting_started
   getting_started/setup_development_environment
   getting_started/setup_vscode
   getting_started/setup_deployment_environment
   getting_started/use_mccs

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: Developer Guide

   developer_guide/index
   developer_guide/tutorials/index.rst
   developer_guide/explanations/index.rst
   developer_guide/how-to_guides/index.rst
   developer_guide/references/index.rst

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: User Guide

   user_guide/index
   user_guide/tutorials/index.rst
   user_guide/explanations/index.rst
   user_guide/how-to_guides/index.rst

.. toctree::
   :maxdepth: 1
   :caption: Reference material

   reference/class_diagrams.rst
   reference/beam_weight.rst
   reference/pointing.rst
   reference/station_pointing_manager.rst
   reference/configuration.rst
   reference/calibration/index.rst
   reference/quality_assurance_metrics/index.rst
   reference/power/index.rst

.. toctree::
   :maxdepth: 1
   :caption: API

   api/index

.. toctree::
   :maxdepth: 1
   :caption: Schemas

   schemas/index

.. toctree::
   :maxdepth: 1
   :caption: Devices

   devices/index
   
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Relevant MCCS projects
----------------------

The MCCS project extends over several repositories, each facilitating a
different part of the system. Since this documentation only covers the
contents of ``ska-low-mccs``, here is a list of all other repositories'
documentation:

- :doc:`SKAO Low MCCS Common <ska-low-mccs-common:index>`
- :doc:`SKAO Low MCCS SPSHW <ska-low-mccs-spshw:index>`
- :doc:`SKAO Low MCCS Calibration <ska-low-mccs-calibration:index>`
- :doc:`SKAO Low MCCS Pasd <ska-low-mccs-pasd:index>`
- :doc:`SKAO Low MCCS Daq <ska-low-mccs-daq:index>`
- :doc:`SKAO Low MCCS Daq Interface <ska-low-mccs-daq-interface:index>`

Note: the above links reference documentation for their stable  branch version.
This may not correspond to the version currently in use by ``ska-low-mccs``.

Dependecies
-----------

- :doc:`SKAO Control Model <ska-control-model:index>`
- :doc:`SKAO Tango Base <ska-tango-base:index>`
- :doc:`Katpoint <katpoint:modules>`
- :doc:`Pytango <pytango:api>`

Note: the above links reference documentation for specific branch versions
intended to match the imported values in ``pyproject.toml``. These two 
values might diverge over time.