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


Documentation
=============


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

   ConfigurationFiles
   GlobalKeywords
   Customizations
   SourceTarget
   FlaggingTranslation

.. grid:: 2
   :gutter: 2

   .. grid-item-card:: Configuration files (csv)
      :link: ConfigurationFiles
      :link-type: doc

      * general csv file syntax
      * use regular expressions
      +++
      *Writing csv files that determine the flagging process*

   .. grid-item-card:: Global Keywords
      :link: GlobalKeywords
      :link-type: doc

      * use `target`, to control result assignment
      * use `label`, to name flagging results
      * use `dfilter`, to filter function input
      * use `flag`, to set function flagging level
      +++
      *Keywords shared by all the flagging functions*

   .. grid-item-card:: Customizations
      :link: Customizations
      :link-type: doc

      * add custom functions to SaQC
      +++
      *Keywords shared by all the flagging functions*