openEO processes

Using an openEO client, we can control FORCE through a number of openEO processes. The FORCE openEO integration is specific to the backend deployed on CDSE, so the processes described here are not listed among the standard processes and are generally experimental.

This page gives an overview of the openEO processes specific to FORCE and client operations needed to interact with them.

The processes wrapping FORCE functionality support most of the options that can be set in the FORCE parameter file (level2, TSA). See the article on parametrization for more details on the supported options and defaults.

To discover the processes, we must first connect to the CDSE openEO backend:

import openeo
connection = openeo.connect("https://openeo.dataspace.copernicus.eu")
connection.authenticate_oidc()

Authenticated using refresh token.

<Connection to 'https://openeo.dataspace.copernicus.eu/openeo/1.2/' with OidcBearerAuth>

Authenticated using refresh token.

If you don’t have your credentials set as environment variables, you will be prompted to log in in a browser window by default. See also the openEO documentation on authentication using Open ID connect (overview, Python client)

We can use openEO’s describe_process API call to discover the parameters of an openEO process.

Query

As a first step, we must determine the input products for FORCE to process. This is best achieved by an external querying method, such as pystac_client. Alternatively, CDSE openEO provides a process query_stac to determine input products from spatial_extent and temporal_extent. Using this process in combination with force_level2 is currently limited to very few input products, therefore we recommend using it only for small tests.

See the next section for an in-depth discussion on the different methods how inputs may be specified.

query_stac process definition

connection.describe_process("query_stac")

Level 2

The openEO integration of FORCE provides a force_level2 process wrapping the FORCE level 2 processing system.

The openEO processes exposes most of the options that can be set in the FORCE level 2 parameter file. Exceptions and additional parameters are described in the parametrization article.

force_level2 process definition

connection.describe_process("force_level2")

Time Series Analysis

The force_tsa process wraps the Time Series Analysis module.

The openEO processes exposes most of the options that can be set in the FORCE TSA parameter file. Exceptions and additional parameters are described in the parametrization article.

force_tsa process definition

connection.describe_process("force_tsa")

openEO job management

Besides the openEO processes which make up the process graph, the openEO client provides functionality to submit, schedule and control jobs. Please refer to the Python client documentation (or the documentation of your preferred openEO client) for a detailed explanation of job management using openEO.

Name	Qualified name (Python client)	Purpose
`create_job`	`openeo.rest.connection.Connection.create_job`	Submit a Process Graph to the backend
`start_and_wait`	`openeo.rest.job.BatchJob.start_and_wait`	Start a submitted job and block until completion
`start`	`openeo.rest.job.BatchJob.start`	Same as `start_and_wait` but do not block execution
`get_results`	`openeo.rest.job.BatchJob.get_results`	Get a `JobResults` object from a completed Job (contains references to output files)
`download_files`	`openeo.rest.job.JobResults.download_files`	Download all assets (files) produced by a job
`download_file`	`openeo.rest.job.JobResults.download_file`	Download a singular asset (file) produced by a job
`export_workspace`	`openeo.rest.stac_resource.StacResource.export_workspace`	Export raw files (FORCE data cube) and STAC to remote cloud storage. Used for asynchronous further processing (TSA) without download of the intermediate result.

Monitoring progress

When using start_and_wait to start a job, status updates will automatically be printed to the command line or jupyter output cell.

Alternatively, progress and logs can be monitored using the openEO web interface at https://openeo.dataspace.copernicus.eu or use the client as explained in the Python client documentation.