Checkout EODAG Jupyterlab extension: eodag-labextension! This will bring a friendly UI to your notebook and help you search and browse for EO products using eodag.
EODAG (Earth Observation Data Access Gateway) is a command line tool and a plugin-oriented Python framework for searching, aggregating results and downloading remote sensed images while offering a unified API for data access regardless of the data provider. The EODAG SDK is structured around three functions:
List collections: list of supported products and their description
Search products (by collection or uid): searches products according to the search criteria provided
Download products: download product “as is”
EODAG is developed in Python. It is structured according to a modular plugin architecture, easily extensible and able to integrate new data providers. Three types of plugins compose the tool:
Catalog search plugins, responsible for searching data (STAC, OpenSearch, OData, …), building paths, retrieving quicklook, combining results
Download plugins, allowing to download and retrieve data locally (via HTTP, S3, …), always with the same directory organization
Authentication plugins, which are used to authenticate the user on the external services used (JSON Token, Basic Auth, OIDC, …).
Read the documentation for more insights.
Installation
EODAG is available on PyPI:
pip install eodagAnd with conda from the conda-forge channel:
conda install -c conda-forge eodagEODAG is also published as a container image on GitHub Container Registry:
docker pull ghcr.io/cs-si/eodag:<version>
docker run --rm ghcr.io/cs-si/eodag:<version> --helpReplace <version> with the EODAG release tag you want to run. See the Docker quickstart for configuration and examples.
[!NOTE]
Please note that EODAG comes with a minimal set of dependencies. If you want more features, please install using one of the available extras.
Usage
For downloading you will need to fill your credentials for the desired providers in your eodag user configuration file. The file will automatically be created with empty values on the first run.
Python API
Example usage for interacting with the api in your Python code:
from eodag import EODataAccessGateway
dag = EODataAccessGateway()
search_results = dag.search(
collection='S2_MSI_L1C',
geom={'lonmin': 1, 'latmin': 43.5, 'lonmax': 2, 'latmax': 44}, # accepts WKT polygons, shapely.geometry, ...
start='2021-01-01',
end='2021-01-15'
)
product_paths = dag.download_all(search_results)This will search for Sentinel 2 level-1C products on the default provider and return the found products first page and an estimated total number of products matching the search criteria. And then it will download these products. Please check the Python API User Guide for more details.
Command line interface
Start playing with the CLI:
To search for some products:
eodag search --collection S2_MSI_L1C --box 1 43 2 44 --start 2021-03-01 --end 2021-03-31
The request above searches for S2_MSI_L1C collections in a given bounding box, in March 2021. It saves the results in a GeoJSON file (search_results.geojson by default).
Results are paginated, you may want to get all pages at once with --all, or search products having 20% of maximum coud cover with --cloud-cover 20. For more information on available options:
eodag search --help
To download the result of the previous call to search:
eodag download --search-results search_results.geojson
To download only the result quicklooks of the previous call to search:
eodag download --quicklooks --search-results search_results.geojson
To list all available collections and supported providers:
eodag list
To list available collections on a specified supported provider:
eodag list -p creodias
To see all the available options and commands:
eodag --help
To print log messages, add -v to eodag master command. e.g. eodag -v list. The more v given (up to 3), the more verbose the tool is. For a full verbose output, do for example: eodag -vvv list
Contribute
Have you spotted a typo in our documentation? Have you observed a bug while running EODAG? Do you have a suggestion for a new feature?
Don’t hesitate and open an issue or submit a pull request, contributions are most welcome!
For guidance on setting up a development environment and how to make a contribution to eodag, see the contributing guidelines.
License
EODAG is licensed under Apache License v2.0. See LICENSE file for details.
Credits
EODAG is built on top of amazingly useful open source projects. See NOTICE file for details about those projects and their licenses. Thank you to all the authors of these projects!
3 maintainers
Metadata
3 maintainers
Release files for eodag 4.9.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| eodag-4.9.2.tar.gz | 11.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| eodag-4.9.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.1 MB
Release files / eodag-4.9.2.tar.gz
| Download URL | eodag-4.9.2.tar.gz |
|---|---|
| Size | 11.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4b0dbbb91c702133978cb74b61d43d73529950f965e445a6f9647cd66ff4febc
|
|
BLAKE2b-256 checksum How to use checksums |
ec28f3980fc4189deb5d5f54a54f9c4e9342f8272feb313b80f6a70848d24bff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / eodag-4.9.2-py3-none-any.whl
| Download URL | eodag-4.9.2-py3-none-any.whl |
|---|---|
| Size | 2.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ee4d213a39c826948b80aeca2c9037e98e17fb1e2103ec38e8f964cc4a8ef808
|
|
BLAKE2b-256 checksum How to use checksums |
1729e9d9621fad81d638ad33fe4a37b8763ca12f7edaa9c40b7685c0c13e0d3c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
