MULTIPLY Prior Engine

This repository contains the prior engine for the MULTIPLY main platform. It provides a priori information to the Inference Engine to support land surface parameter retrieval. The documentation is part of the MULTIPLY core documentation on ReadTheDocs.

Contents

• aux_data/ Auxiliary data for prior generation.
• doc - The auto generated documentation of all prior engine classes and function definitions.
• multiply_prior-engine/ - The main prior engine software package. as source of information and orientation.
• recipe Conda installation recipe.
• test/ - The test package.
• setup.py - main build script, to be run with Python 3.6
• LICENSE.md - License of software in repository.

How to install

The first step is to clone the latest code and step into the check out directory:

$ git clone https://github.com/multiply-org/prior-engine.git
$ cd prior-engine

The MULTIPLY platform has been developed against Python 3.6. It cannot be guaranteed to work with previous Python versions.

The MULTIPLY prior engine can be run from sources directly. To install the MULTIPLY prior engine into an existing Python environment just for the current user, use

$ python setup.py install --user

To install the MULTIPLY Core for development and for the current user, use

$ python setup.py develop --user

Module requirements

• python-dateutil
• gdal
• matplotlib
• numpy
• pyyaml
• shapely

How to use

MULTIPLY prior engine is available as Python Package. To import it into your python application, use

import multiply_prior_engine

Generating the Documentation

We use Sphinx to generate the documentation of the MULTIPLY platform on ReadTheDocs.

The source files of the main documentation of the MULTIPLY platform is to be found in the MULTIPLY core repository.

If there is a need to build the prior engine specific docs locally, these additional software packages are required:

$ conda install sphinx sphinx_rtd_theme mock
$ conda install -c conda-forge sphinx-argparse
$ pip install sphinx_autodoc_annotation

To regenerate the HTML docs, type

$ cd doc
$ make html

Authors

• Joris Timmermans - Work on vegetation priors
• Thomas Ramsauer - Work on soil priors

License

This project is licensed under the GPLv3 License - see the LICENSE.md file for details

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.