Metadata-Version: 2.1
Name: qa4sm-preprocessing
Version: 0.1.6
Summary: Preprocessing routines for QA4SM
Home-page: https://github.com/pyscaffold/pyscaffold/
Author: TU Wien
Author-email: remote.sensing@geo.tuwien.ac.at
License: MIT
Project-URL: Documentation, https://pyscaffold.org/
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Description-Content-Type: text/x-rst; charset=UTF-8
Provides-Extra: testing
License-File: LICENSE.txt
License-File: AUTHORS.rst

===================
qa4sm-preprocessing
===================

.. image:: https://github.com/awst-austria/qa4sm-preprocessing/workflows/Automated%20Tests/badge.svg?branch=master&event=push
   :target: https://github.com/awst-austria/qa4sm-preprocessing/actions

.. image:: https://coveralls.io/repos/awst-austria/qa4sm-preprocessing/badge.png?branch=master
  :target: https://coveralls.io/r/awst-austria/qa4sm-preprocessing?branch=master

.. image:: https://badge.fury.io/py/qa4sm-preprocessing.svg
    :target: https://badge.fury.io/py/qa4sm-preprocessing


This package contains functions to preprocess certain data before using them
in the QA4SM online validation framework.

ISMN FRM
========

This module contains the routine to assign FRM qualifications ISMN sensors.
The Quality Indicators (QIs) are based on a Triple Collocation run with
80% CI between ISMN (0-10 cm, "good" time stamps), ERA5-Land ("swvl1") and
ESA CCI SM v06.1 PASSIVE. See ``./docs/ismn_frm.rst`` for more details.


CGLS HR SSM SWI
===============

Read CGLS HR SSM and SWI images (1km sampling) in netcdf format and convert
them to time series.
The image reader allows reading/converting data for a spatial subset (bbox) only.
Time series are stored in 5*5 DEG cell files, i.e. there are `~250 000 time series`
stored in one single cell file.

Time series reading is done based on cell level. Up to 6 cells are loaded into
memory at a time. The ``read_area`` function allows reading multiple GPI time series
around one location at once (and optionally converting them into a single, averaged
series, to represent the mean SM for an area).

Necessary updates
-----------------
At the moment it is only possible to read a single variable. However, in order
to mask SM time series based in location quality flags, it is necessary to
read multiple parameters. When passing the averaged time series for an area
to `pytesmo` for validation, masking can not be done in `pytesmo`, but must be done
beforehand.


.. _pyscaffold-notes:

Note
====

This project has been set up using PyScaffold 4.0.2. For details and usage
information on PyScaffold see https://pyscaffold.org/.
