.. pysiral documentation master file, created by
   sphinx-quickstart on Mon Apr 29 11:25:13 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


Welcome to pysiral's documentation!
===================================

This is the main page for the technical documentation of the python sea ice radar altimetry (pysiral) toolbox.


.. note::
   The documentation is work in progress.

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

   what_is_pysiral.rst
   installation.rst
   configuration.rst
   checklist.rst
   glossary.rst

.. toctree::
   :maxdepth: 1
   :caption: Supported Datasets

   radar_altimeter_datasets.rst
   auxiliary/auxiliary_datasets.rst

.. toctree::
   :maxdepth: 1
   :caption: Functionality

   l1preproc.rst
   l2proc.rst
   l2preproc.rst
   l3proc.rst

.. toctree::
   :maxdepth: 1
   :caption: Using pysiral

   scripts/console_scripts.rst
   scripts/info.rst
   scripts/config.rst
   scripts/l1preproc.rst
   scripts/l2proc.rst
   scripts/l2preproc.rst
   scripts/l3proc.rst

.. toctree::
   :maxdepth: 1
   :caption: Roadmap

   roadmap.rst

.. toctree::
   :maxdepth: 1
   :caption: Contributing to pysiral

   contributing.rst
   codingconv.rst

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