Skip to content

Latest commit

 

History

History
181 lines (125 loc) · 6.54 KB

README.md

File metadata and controls

181 lines (125 loc) · 6.54 KB
Raw

Build Status Coverage Status

Data gathering for GeoSPaaS

This application can be used to search for satellite or model data from various providers and ingest metadata into a GeoSPaaS database. It relies on Django for data access. Specifically, it uses the models defined in django-geo-spaas.

This readme explains the basic usage of this package. Documentation aimed at developers can be found here.

Interfaces

The main interface is the CLI. A Web interface may be implemented in the future.

Command line

The CLI can be accessed through the geospaas_harvesting.cli module. If no option is given, it will use the default configuration file.

Example:

python -m geospaas_harvesting.cli harvest

Base options

-c, --config

Path to a custom configuration file can be specified. See this section for more details. If not provided, the default configuration file is used.

Example:

python -m geospaas_harvesting.cli -c ./config.yml harvest
-h, --help

Prints the help message

Subcommands

harvest

The harvest subcommand runs searches based on the search.yml file (example here) and ingests the results in the database.

-s, --search

A path to a search configuration file. See this section for more details.

python -m geospaas_harvesting.cli -c ./config.yml harvest -s ./search.yml
list

Display a list of the available providers and their search parameters.

python -m geospaas_harvesting.cli -c ./config.yml list

Web interface

Not implemented yet.

Warning before starting the harvesting process

Before harvesting data, the database must be initialized with Vocabulary objects. The update can be done automatically and is controlled by the update_vocabularies, update_pythesint and pythesint_versions in the configuration file. If you don't know what this means, it is best to keep the default values.

Configuration

Files

All configuration files are in YAML. The !ENV tag allows to use environment variables as values.

config.yml

The configuration of the harvesters is defined in this file. An example can be seen in the default configuration file.

Top-level keys:

  • update_vocabularies (default: True): update the Vocabulary objects stored in the database with the local pythesint data. If update_pythesint is also set to True, the local data is refreshed before the database is updated.
  • update_pythesint (default: False): update the local pythesint data before harvesting. Note that setting this parameter to True will have no effect if update_vocabularies is set to False.
  • pythesint_versions (default: None): the pythesint vocabularies versions to use. This is a dictionary in which each key is a pythesint vocabulary name and each value is the corresponding version string.
  • providers: dictionary mapping the providers names to a dictionary containing their settings.
Providers configuration

The properties which are common to every harvester are:

  • type (mandatory): the type of provider. For a list of available harvesters see harvesters.py.

The rest depends on the harvester and will be detailed in each provider's documentation.

Search configuration

This file is used to set the search parametersfor each provider you wish to use. By default, the CLI looks for a file called search.yml in the folder from which the search/harvest command is run.

It contains two sections:

  • common: dictionary of parameters which will be applied to all the searches, unless overriden
  • searches: a list of dictionaries, each containing search parameters suited to a provider. Each dictionary contained in that list must have the provider_name key defined.

The list subcommand can be used to find out which search parameters each provider supports. The search parameters can have the following types:

  • any type: can be anything
  • boolean
  • multiple choices: choose one in a set of valid options
  • datetime: a string representing a date and time. Must be readable by dateutil. Example: '2020-04-20T00:00:00Z'
  • dictionary: key-value mapping
  • list
  • path: string representing an absolute path
  • string
  • WKT string: string representing a geometry in the WKT format.

Some providers define specific parameters types as needed.

Common parameters

These search parameters can be used for every provider:

  • start_time and end_time: used to define the temporal coverage.
  • location: a WKT string defining a shape defining the spatial coverage.
Example
---
common: # these are common to all searches
  start_time: '2022-07-13'
  end_time: '2022-07-14'
  location: 'POLYGON ((-43.2346 59.8972, -37.1701 62.2756, -31.8527 64.3661, -25.8762 65.8635, -20.7126 68.37690000000001, -19.9435 69.3939, -22.756 70.0712, -26.6232 68.8853, -32.2922 68.25920000000001, -36.6867 66.7291, -41.1252 65.0235, -42.6633 62.8226, -43.2346 59.8972))'
searches:
- provider_name: 'creodias'
  collection: 'Sentinel1'
  processingLevel: 'LEVEL1'
  productType: 'GRD'

- provider_name: 'earthdata_cmr'
  short_name: 'VIIRSJ1_L2_OC_NRT'
  start_time: '2018-12-01T00:00:00Z'
  end_time: '2018-12-04T12:00:00Z'

Environment variables

Generic configuration can be defined using environment variables:

  • GEOSPAAS_HARVESTING_LOG_CONF_PATH: path to the logging configuration file
  • GEOSPAAS_FAILED_INGESTIONS_DIR: path to the directory where information about datasets for which errors occurred is stored
  • SECRET_KEY: Django secret key
  • GEOSPAAS_DB_HOST: database hostname
  • GEOSPAAS_DB_PORT: database port
  • GEOSPAAS_DB_NAME: database name
  • GEOSPAAS_DB_USER: database username
  • GEOSPAAS_DB_PASSWORD: database password

Other environment variables can be defined in the configuration files by using the !ENV tag.