qa4sm-reader 0.2.2

Processes output of qa4sm.eodc.eu (NetCDF file), creating plots and providing the data in other formats.

qa4sm_reader is a python package to read and plot the result files of the qa4sm service.

Installation

This package should be installable through pip (not yet tough, see development):

pip install qa4sm_reader

Usage

# TODO

Development Setup

The project was setup using pyscaffold and closely follows the recommendations.

Install Dependencies

For Development we recommend creating a conda environment.

cd qa4sm-reader
conda env create #  create environment from requirements.rst
conda activate qa4sm-reader
python setup.py develop #  Links the code to the environment

To remove the environment again, run:

conda deactivate
conda env remove -n qa4sm_reader

Testing

For testing, we use py.test:

python setup.py pytest

The dependencies are automatically installed by pytest-runner when you run the tests. The test-dependencies are listed in the testing field inside the [options.extras_require] section of setup.cfg. For some reason, the dependencies are not installed as expected. To workaround, do:

pip install pytest-cov

The files used for testing are included in this package. They are however subject to other terms and conditions.

Known Issues

When creating a boxplot with five or more boxes, the text might overlap. (see tests/test_ncplot/test_boxplot_GLDAS_nan_default() and tests/test_ncplot/test_boxplot_ISMN_nan_default() )

For some