=========================================================
s2_rut_python Documentation
=========================================================

A package containing tools to aid the filtering of EO data based on ancillary data such as land masks, ice masks or atmospheric properties

.. grid:: 2
   :gutter: 2

   .. grid-item-card::  User Guide
      :link: content/user/user_guide
      :link-type: doc

      The user guide provides information on how to get started with s2_rut_python,
      as well as some more detailed information about its features.

   .. grid-item-card::  ATBD
      :link: content/user/atbd
      :link-type: doc

      The algorithm theoretical basis documentation describes the science underpinning
      s2_rut_python

   .. grid-item-card::  API Reference
      :link: content/user/api
      :link-type: doc

      The reference guide contains a detailed description of the s2_rut_python
      API. It describes how the functions, classes and methods of the package work.

   .. grid-item-card::  Developer Guide
      :link: content/developer/developer_guide
      :link-type: doc

      The developer guide describes how to contribute to s2_rut_python.


Acknowledgements
----------------

s2_rut_python has been developed by `Jacob Fahy <jacob.fahy@npl.co.uk>`_.

Project status
--------------

s2_rut_python is under active development. It is beta software.

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: For users

   User Guide <content/user/user_guide>
   ATBD <content/user/atbd>
   API Reference <content/user/api>

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: For developers/contributors

   Developer Guide <content/developer/developer_guide>