Earth Observation Data Access Gateway
Project description
eodag
EODAG (Earth Observation Data Access Gateway) is a command line tool and a plugin-oriented Python framework for searching, crunching and downloading remote sensed images (mainly from satellite images providers).
You can search and download satellite products:
through the embedded cli:
eodag search --conf user.conf.yaml \ --geometry 1 43 2 44 \ --startTimeFromAscendingNode 2018-01-01 \ --completionTimeFromAscendingNode 2018-01-31 \ --cloudCover 20 \ --productType S2_MSI_L1C # With the shortcut arguments eodag search -f user.conf.yaml -b 1 43 2 44 -s 2018-01-01 -e 2018-01-31 -c 20 -p S2-L1Cby interacting with the api in your Python code:
from eodag import SatImagesAPI dag = SatImagesAPI(user_conf_file_path='/path/to/user/conf.yaml') product_type = 'S2_MSI_L1C' footprint = {'lonmin': 1, 'latmin': 43.5, 'lonmax': 2, 'latmax': 44} start, end = '2018-01-01', '2018-01-31' search_results = dag.search( product_type, geometry=footprint, startTimeFromAscendingNode=start, completionTimeFromAscendingNode=end, ) product_paths = dag.download_all(search_results) for path in product_paths: print('Downloaded : {}'.format(path))
Read the documentation for more insights.
Installation
EODAG is on PyPI:
python -m pip install eodag
Usage
Command line interface
Create a configuration file from the template provided with the repository, filling in your credentials as expected by each provider:
cp eodag/user_conf_template.yml my_conf.yml
Then you can start playing with it:
To search for products and crunch the results of the search:
eodag search \ --conf my_conf.yml \ --geometry 1 43 2 44 \ --startTimeFromAscendingNode 2018-01-01 --completionTimeFromAscendingNode 2018-01-31 \ --productType S2_MSI_L1C \ --cruncher FilterLatestIntersect \ --storage my_search.geojson
The request above search for product types S2_MSI_L1C and will crunch the result using cruncher FilterLatestIntersect and storing the overall result to my_search.geojson.
You can pass arguments to a cruncher on the command line by doing this (example with using FilterOverlap cruncher which takes minimum_overlap as argument):
eodag search -f my_conf.yml -b 1 43 2 44 -s 2018-01-01 -e 2018-01-31 -p S2_MSI_L1C \
--cruncher FilterOverlap \
--cruncher-args FilterOverlap minimum_overlap 10
The request above means : “Give me all the products of type S2_MSI_L1C, use FilterOverlap to keep only those products that are contained in the bbox I gave you, or whom spatial extent overlaps at least 10% (minimum_overlap) of the surface of this bbox”
To download the result of a previous call to search:
eodag download --conf my_conf.yml --search-results my_search.geojson
To list all available product types and supported providers:
eodag list
To list available product types on a specified supported provider:
eodag list -s airbus-ds
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.
Note on how to get Amazon Web Services access keys
Create an account on AWS website: https://aws.amazon.com/fr/ (warning: A credit card number must be given because data become paying after a given amount of downloaded data).
Once the account is activated go to the identity and access management console: https://console.aws.amazon.com/iam/home#/home
Click on user, then on your user name and then on security credentials.
In access keys, click on create access key.
Add these credentials to the user conf file.
Contribute
If you intend to contribute to eodag source code:
git clone https://bitbucket.org/geostorm/eodag.git cd eodag python -m pip intall -r requirements-dev.txt
To run the default test suite (which excludes end-to-end tests):
tox
To only run end-to-end test:
tox -- tests.test_end_to_end
To run the entire tests (units, integraton and end-to-end):
tox -- tests eodag
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 !
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for eodag-0.2.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7bc288b0befdaa19af6583744c6cdf78806db709d1a9ff13c492bd20144a7e88 |
|
| MD5 | 54d527fec67329833c03fb439a5ac359 |
|
| BLAKE2b-256 | 8addcb5fb6bacbfe44f56ba8780539a6381f29f12e4102da97f35cc6f102f657 |
