Welcome to 4FS ETC's documentation!
===================================

.. image:: titleimage.jpg

The 4FS\_ETC is the software package used to fold (large numbers of)
template spectra through the 4MOST system response, and optionally to
assess whether the folded spectra have met specified success criteria.

The main usage of the package is in the `4MOST Facility Simulator (4FS)`_.

.. _4MOST Facility Simulator (4FS): https://4most.mpe.mpg.de/QFSwi/


Software documentation
----------------------

.. module:: qmostetc

.. toctree::
   :maxdepth: 2

   introduction
   description
   tools
   format
   api
   verification
   changes


Development links
-----------------

* `Gitlab repository`_

* `Jira ticket system`_

.. _Gitlab repository: https://gitlab.4most.eu/OpSys/etc

.. _Jira ticket system: https://4most-tickets.atlassian.net/issues/?jql=project%20%3D%20QFS%20AND%20component%20%3D%20ETC


Relevant 4MOST documents
------------------------

* ETC Requirements Specification, VIS-SPE-4MOST-47110-1740-0001_

* Online-4FS user manual (including file format specification), VIS-MAN-4MOST-47110-1720-0001_

* DMS Level 1 Pipeline DXU, VIS-TNO-4MOST-47110-0143-0001_

.. _VIS-SPE-4MOST-47110-1740-0001: https://ds-web.aip.de/docushare/dsweb/Services/Document-8238

.. _VIS-MAN-4MOST-47110-1720-0001: https://ds-web.aip.de/docushare/dsweb/Services/Document-3915

.. _VIS-TNO-4MOST-47110-0143-0001: https://ds-web.aip.de/docushare/dsweb/Services/Document-8977