.. SPDX-FileCopyrightText: 2021 Helmholtz-Zentrum für Umweltforschung GmbH - UFZ
..
.. SPDX-License-Identifier: GPL-3.0-or-later

.. include:: misc/title.rst


.. toctree::
   :hidden:
   :maxdepth: 1

   Repository <https://git.ufz.de/rdm-software/saqc>

Getting Started
===============

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

   gettingstarted/InstallationGuide
   gettingstarted/TutorialAPI
   gettingstarted/TutorialCLI


.. toctree::
   :caption: Cookbooks
   :maxdepth: 1
   :hidden:

   cookbooks/DataRegularisation
   cookbooks/OutlierDetection
   cookbooks/MultivariateFlagging

.. toctree::
   :caption: Documentation
   :maxdepth: 1
   :hidden:

   documentation/ConfigurationFiles
   documentation/GenericFunctions
   documentation/GlobalKeywords
   documentation/Customizations
   documentation/SourceTarget
   documentation/FlaggingTranslation

..
   .. toctree::
      :caption: Functions
      :hidden:
      :maxdepth: 1
      :glob:
      :titlesonly:

      resampling <funcs/resampling>
      generic <funcs/generic>
      outliers <funcs/outliers>
      breaks <funcs/breaks>
      constants <funcs/constants>
      changepoints <funcs/changepoints>
      drift <funcs/drift>
      curvefit <funcs/curvefit>
      interpolation <funcs/interpolation>
      residuals <funcs/residuals>
      tools <funcs/tools>
      flagtools <funcs/flagtools>
      rolling <funcs/rolling>
      scores <funcs/scores>
      transformation <funcs/transformation>
      noise <funcs/noise>
      pattern <funcs/pattern>


.. toctree::
   :caption: SaQC
   :hidden:
   :maxdepth: 2

   Package <modules/SaQC>
   Core <modules/SaQCCore>
   Test Functions <modules/SaQCFunctions>
   Translations <modules/SaQCTranslation>
   Constants <modules/SaQCConstants>

.. toctree::
   :caption: Developer Resources
   :hidden:
   :maxdepth: 1

   Documentation Guide <howtodoc/HowToDoc>
   Writing Functions <documentation/WritingFunctions>


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

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