openEO Python Client¶
Welcome to the documentation of openeo
,
the official Python client library for interacting with openEO back-ends
to process remote sensing and Earth observation data.
It provides a Pythonic interface for the openEO API,
supporting data/process discovery, process graph building,
batch job management and much more.
Usage example¶
A simple example, to give a feel of using this library:
import openeo
# Connect to openEO back-end.
connection = openeo.connect("openeo.vito.be").authenticate_oidc()
# Load data cube from TERRASCOPE_S2_NDVI_V2 collection.
cube = connection.load_collection(
"TERRASCOPE_S2_NDVI_V2",
spatial_extent={"west": 5.05, "south": 51.21, "east": 5.1, "north": 51.23},
temporal_extent=["2022-05-01", "2022-05-30"],
bands=["NDVI_10M"],
)
# Rescale digital number to physical values and take temporal maximum.
cube = cube.apply(lambda x: 0.004 * x - 0.08).max_time()
cube.download("ndvi-max.tiff")
Table of contents¶
- openEO Python Client
- Installation
- Getting Started
- Finding and loading data
- Working with processes
- Batch Jobs
- User-Defined Processes (UDP)
- Authentication and Account Management
- Basic HTTP Auth
- OpenID Connect Based Authentication
- OIDC Authentication: Device Code Flow
- OIDC Authentication: Refresh Token Flow
- OIDC Authentication: Client Credentials Flow
- OIDC Authentication: Dynamic Method Selection
- Auth config files and
openeo-auth
helper tool - Default openEO back-end URL and auto-authentication
- Authentication for long-running applications and non-interactive contexts
- Best Practices and Troubleshooting Tips
- User-Defined Functions (UDF) explained
- Applicability and Constraints
- UDF function names and signatures
- A first example:
apply
with an UDF to rescale pixel values - UDF’s that transform cube metadata
- Example:
apply_dimension
with a UDF - Example:
reduce_dimension
with a UDF - Example:
apply_neighborhood
with a UDF - Example: Smoothing timeseries with a user defined function (UDF)
- Downloading a datacube and executing an UDF locally
- UDF dependency management
- Profile a process server-side
- Logging from a UDF
openeo.UDF
API and usage changes in version 0.13.0
- DataCube construction
- Machine Learning
- Configuration
- openEO CookBook
- API (General)
- High level Interface
- openeo
- openeo.rest.datacube
- openeo.rest.vectorcube
- openeo.rest.mlmodel
- openeo.rest.multiresult
- openeo.metadata
- openeo.api.process
- openeo.api.logs
- openeo.rest.connection
- openeo.rest.job
- openeo.rest.conversions
- openeo.rest.udp
- openeo.rest.userfile
- openeo.udf
- openeo.util
- openeo.processes
- Graph building
- Testing
- API:
openeo.processes
- openEO Process Mapping
- Development and maintenance
- Best practices, coding style and general tips
- Changelog
- [Unreleased]
- [0.35.0] - 2024-11-19
- [0.34.0] - 2024-10-31
- [0.33.0] - 2024-10-18
- [0.32.0] - 2024-09-27
- [0.31.0] - 2024-07-26
- [0.30.0] - 2024-06-18
- [0.29.0] - 2024-05-03
- [0.28.0] - 2024-03-18
- [0.27.0] - 2024-01-12
- [0.26.0] - 2023-11-27 - “SRR6” release
- [0.25.0] - 2023-11-02
- [0.24.0] - 2023-10-27
- [0.23.0] - 2023-10-02
- [0.22.0] - 2023-08-09
- [0.21.1] - 2023-07-19
- [0.21.0] - 2023-07-19
- [0.20.0] - 2023-06-30
- [0.19.0] - 2023-06-16
- [0.18.0] - 2023-05-31
- [0.17.0] and [0.17.1] - 2023-05-16
- [0.16.0] - 2023-04-17 - “SRR5” release
- [0.15.0] - 2023-03-03
- [0.14.1] - 2023-02-06
- [0.14.0] - 2023-02-01
- [0.13.0] - 2022-10-10 - “UDF UX” release
- [0.12.1] - 2022-09-15
- [0.12.0] - 2022-09-09
- [0.11.0] - 2022-07-02
- [0.10.1] - 2022-05-18 - “LPS22” release
- [0.10.0] - 2022-04-08 - “SRR3” release
- [0.9.2] - 2022-01-14
- [0.9.1] - 2021-11-16
- [0.9.0] - 2021-10-11
- [0.8.2] - 2021-08-24
- [0.8.1] - 2021-08-24
- [0.8.0] - 2021-06-25
- [0.7.0] - 2021-04-21
- [0.6.1] - 2021-03-29
- [0.6.0] - 2021-03-26
- [0.5.0] - 2021-03-17
- [0.4.10] - 2021-02-26
- [0.4.9] - 2021-01-29
- [0.4.8] - 2020-11-17
- [0.4.7] - 2020-10-22
- [0.4.6] - 2020-10-15
- [0.4.5] - 2020-10-01
- [0.4.4] - 2020-08-20