Commit 2ed4dfdf authored by Daniel Scheffler's avatar Daniel Scheffler

Added some documentation about the GMS infrastructure.

Signed-off-by: Daniel Scheffler's avatarDaniel Scheffler <danschef@gfz-potsdam.de>
parent 76b34dde
Pipeline #15859 passed with stages
in 10 minutes and 50 seconds
......@@ -15,6 +15,7 @@ Documentation of the gms_preprocessing package
about
Source code repository <https://gitext.gfz-potsdam.de/geomultisens/gms_preprocessing>
installation
infrastructure
algorithm_descriptions
usage
modules
......
**************
Infrastructure
**************
This section gives an overview about what is needed to run pre-processing / homogenization jobs of gms_preprocessing
on your machine.
.. include:: infrastructure/ecmwf_db.rst
.. include:: infrastructure/postgresql_db.rst
ECMWF database
==============
The atmospheric correction implemented in gms_preprocessing (`SICOR <https://gitext.gfz-potsdam.de/EnMAP/sicor>`_)
uses `ECMWF <https://www.ecmwf.int/>`_ data (European Centre for Medium-Range Weather Forecasts) to model the
atmospheric state for each scene processed.
These data are ...
* either **downloaded during runtime** for the current scene to process,
* or **downloaded in batch** for specific time intervals before running gms_preprocessing.
To be able to download the data, you need to create an account for the ECMWF Web API and save a file called
`.ecmwfapirc` to your home directory that contains your access token.
See `here <https://www.ecmwf.int/en/forecasts/access-forecasts/ecmwf-web-api>`__ for further details.
The file path of your local ECMWF database (which is automatically created by gms_preprocessing when downloading ECMWF
data) can be set with a configuration parameter of gms_preprocessing.
PostgreSQL metadata database
============================
* TODO
......@@ -12,6 +12,7 @@ Python API
.. toctree::
:maxdepth: 4
usage/setting_a_configuration.rst
usage/add_new_data_to_the_database.rst
usage/create_new_jobs.rst
usage/execute_jobs.rst
......
Setting a configuration
-----------------------
......@@ -86,8 +86,8 @@ def set_config(job_ID, json_config='', reset_status=False, **kwargs):
:param json_config: path to JSON file containing configuration parameters or a string in JSON format
:param reset_status: whether to reset the job status or not (default=False)
:param kwargs: keyword arguments to be passed to JobConfig
NOTE: All keyword arguments given here WILL OVERRIDE configurations that have been previously set via WebUI!
NOTE: All keyword arguments given here WILL OVERRIDE configurations that have been
previously set via WebUI or via the json_config parameter!
:Keyword Arguments:
- inmem_serialization: False: write intermediate results to disk in order to save memory
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment