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

.. _gettingstarted:

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

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

   InstallationGuide
   TutorialAPI
   TutorialCLI

.. grid:: 3
   :gutter: 2

   .. grid-item-card:: Installation Guide
      :link: InstallationGuide
      :link-type: doc

      * *windows* and *linux* installation guide
      * set up a work environment
      * get *SaQC* from *PyPi*

   .. grid-item-card:: API Usage
      :link: TutorialAPI
      :link-type: doc

      * initialise the *SaQC* object
      * put together basic *flagging pipeline*
      * obtain and *plot results*

   .. grid-item-card:: Command Line Interface Usage
      :link: TutorialCLI
      :link-type: doc

      * use the *SaQC* command line interface
      * introduction to csv-file syntax