Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Browse accepted projects | Review proposed projects | Propose new project | Open Issues

EODAG

Gives you an easy way to access products from more than 10 earth observation providers, with more than 50 different product types (Sentinel 1, Sentinel 2, Sentinel 3, Landsat, etc.) that can be searched and downloaded.
https://github.com/cs-si/eodag

catalog cbers copernicus downloader earth-observation eodag geographic-data geospatial gis landsat modis remote-sensing satellite-imagery search sentinel spatial-imagery stac

Last synced: about 1 hour ago
JSON representation

Repository metadata

Earth Observation Data Access Gateway

README

        

.. image:: https://eodag.readthedocs.io/en/latest/_static/eodag_bycs.png
:target: https://github.com/CS-SI/eodag

|

.. image:: https://badge.fury.io/py/eodag.svg
:target: https://badge.fury.io/py/eodag

.. image:: https://img.shields.io/conda/vn/conda-forge/eodag
:target: https://anaconda.org/conda-forge/eodag

.. image:: https://readthedocs.org/projects/eodag/badge/?version=latest&style=flat
:target: https://eodag.readthedocs.io/en/latest/

.. image:: https://github.com/CS-SI/eodag/actions/workflows/test.yml/badge.svg
:target: https://github.com/CS-SI/eodag/actions

.. image:: https://img.shields.io/github/issues/CS-SI/eodag.svg
:target: https://github.com/CS-SI/eodag/issues

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/git/https%3A%2F%2Fgithub.com%2FCS-SI%2Feodag.git/master?filepath=docs%2Fnotebooks%2Fintro_notebooks.ipynb

|

.. image:: https://img.shields.io/pypi/l/eodag.svg
:target: https://pypi.org/project/eodag/

.. image:: https://img.shields.io/pypi/pyversions/eodag.svg
:target: https://pypi.org/project/eodag/

|

..

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 product types: list of supported products and their description

* Search products (by product type 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 (OpenSearch, CSW, ...), building paths, retrieving quicklook,
combining results

* Download plugins, allowing to download and retrieve data locally (via FTP, HTTP, ..), always with the same directory
organization

* Authentication plugins, which are used to authenticate the user on the external services used (JSON Token, Basic Auth, OAUTH, ...).

Since v2.0 EODAG can be run as `STAC client or server `_.

Read `the documentation `_ for more insights.

.. image:: https://raw.githubusercontent.com/CS-SI/eodag/develop/docs/_static/eodag_overview.png
:alt: EODAG overview
:class: no-scaled-link

Installation
============

EODAG is available on `PyPI `_:

.. code-block:: bash

python -m pip install eodag

And with ``conda`` from the `conda-forge channel `_:

.. code-block:: bash

conda install -c conda-forge eodag

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:

.. code-block:: python

from eodag import EODataAccessGateway

dag = EODataAccessGateway()

search_results, total_count = dag.search(
productType='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.

STAC REST API
-------------

An eodag instance can be exposed through a STAC compliant REST api from the command line:

.. code-block:: bash

$ eodag serve-rest --help
Usage: eodag serve-rest [OPTIONS]

Start eodag HTTP server

Set EODAG_CORS_ALLOWED_ORIGINS environment variable to configure Cross-
Origin Resource Sharing allowed origins as comma-separated URLs (e.g.
'http://somewhere,htttp://somewhere.else').

Options:
-f, --config PATH File path to the user configuration file with its
credentials, default is ~/.config/eodag/eodag.yml
-l, --locs PATH File path to the location shapefiles configuration file
-d, --daemon run in daemon mode
-w, --world run uvicorn using IPv4 0.0.0.0 (all network interfaces),
otherwise bind to 127.0.0.1 (localhost).
-p, --port INTEGER The port on which to listen [default: 5000]
--debug Run in debug mode (for development purpose)
--help Show this message and exit.

# run server
$ eodag serve-rest

# list available product types for ``peps`` provider:
$ curl "http://127.0.0.1:5000/collections?provider=peps" | jq ".collections[].id"
"S1_SAR_GRD"
"S1_SAR_OCN"
"S1_SAR_SLC"
"S2_MSI_L1C"
"S2_MSI_L2A"

# search for items
$ curl "http://127.0.0.1:5000/search?collections=S2_MSI_L1C&bbox=0,43,1,44&datetime=2018-01-20/2018-01-25" \
| jq ".numberMatched"
6

# browse for items
$ curl "http://127.0.0.1:5000/catalogs/S2_MSI_L1C/country/FRA/year/2021/month/01/day/25/cloud_cover/10/items" \
| jq ".numberMatched"
9

# get download link
$ curl "http://127.0.0.1:5000/catalogs/S2_MSI_L1C/country/FRA/year/2021/month/01/day/25/cloud_cover/10/items" \
| jq ".features[0].assets.downloadLink.href"
"http://127.0.0.1:5000/catalogs/S2_MSI_L1C/country/FRA/year/2021/month/01/day/25/cloud_cover/10/items/S2A_MSIL1C_20210125T105331_N0209_R051_T31UCR_20210125T130733/download"

# download
$ wget "http://127.0.0.1:5000/catalogs/S2_MSI_L1C/country/FRA/year/2021/month/01/day/25/cloud_cover/10/items/S2A_MSIL1C_20210125T105331_N0209_R051_T31UCR_20210125T130733/download"

``eodag-server`` is available on `https://hub.docker.com/r/csspace/eodag-server `_:

.. code-block:: bash

docker run -p 5000:5000 --rm csspace/eodag-server:2.12.0

You can also browse over your STAC API server using `STAC Browser `_.
Simply run:

.. code-block:: bash

git clone https://github.com/CS-SI/eodag.git
cd eodag
docker-compose up
# or for a more verbose logging:
EODAG_LOGGING=3 docker-compose up

And browse http://127.0.0.1:5001:

.. image:: https://raw.githubusercontent.com/CS-SI/eodag/develop/docs/_static/stac_browser_example_600.png
:target: https://raw.githubusercontent.com/CS-SI/eodag/develop/docs/_static/stac_browser_example.png
:alt: STAC browser example
:width: 600px

For more information, see `STAC REST API usage `_.

Command line interface
----------------------

Start playing with the CLI:

- To search for some products::

eodag search --productType S2_MSI_L1C --box 1 43 2 44 --start 2021-03-01 --end 2021-03-31

The request above searches for ``S2_MSI_L1C`` product types 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 ``--cloudCover 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 product types and supported providers::

eodag list

- To list available product types 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`_.

.. _contributing guidelines: https://github.com/CS-SI/eodag/blob/develop/CONTRIBUTING.rst

License
=======

EODAG is licensed under Apache License v2.0.
See LICENSE file for details.

Authors
=======

EODAG has been created by `CS GROUP - France `_.

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!


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 10 days ago

Total Commits: 1,072
Total Committers: 25
Avg Commits per committer: 42.88
Development Distribution Score (DDS): 0.517

Commits in past year: 204
Committers in past year: 8
Avg Commits per committer in past year: 25.5
Development Distribution Score (DDS) in past year: 0.363

Name Email Commits
Sylvain Brunato 6****o 518
Adrien Oyono a****o@g****m 162
Adrien Oyono a****o@c****r 110
Maxime Liquet 3****t 60
Adrien Oyono e****e@y****r 44
orhygine a****s@g****m 38
github-actions[bot] 4****] 26
jlahovnik 1****k 19
Clément Cazorla c****a@c****r 18
CGuichard 3****d 17
anesson-cs 1****s 16
alambare-csgroup 9****p 12
bjgiraudon 6****n 8
dalpasso 1****o 7
BRUNATO Sylvain s****o@c****u 3
Meylheuc b****c@c****r 3
Alvaro Huarte a****7@y****s 2
Stéphan AIME s****e@c****r 2
ctriquet c****t@c****r 1
Leigh 8****p 1
Leonid 4****r 1
Rémi Braun 6****n 1
Leso_KN i****o@l****m 1
Apparell b****u@g****m 1
Denis Rykov r****d@g****m 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 179
Total pull requests: 273
Average time to close issues: 6 months
Average time to close pull requests: 9 days
Total issue authors: 37
Total pull request authors: 11
Average comments per issue: 1.08
Average comments per pull request: 2.49
Merged pull request: 231
Bot issues: 0
Bot pull requests: 36

Past year issues: 127
Past year pull requests: 254
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 10 days
Past year issue authors: 29
Past year pull request authors: 10
Past year average comments per issue: 0.65
Past year average comments per pull request: 2.54
Past year merged pull request: 214
Past year bot issues: 0
Past year bot pull requests: 34

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/cs-si/eodag

Top Issue Authors

  • sbrunato (98)
  • alambare-csgroup (13)
  • anesson-cs (9)
  • maximlt (7)
  • remi-braun (4)
  • Rapsodia86 (4)
  • koleckt (4)
  • iliion (3)
  • ansotoo (2)
  • savmickael (2)
  • jlahovnik (2)
  • varisht-tathya (2)
  • harshal306 (2)
  • floriandeboissieu (2)
  • EugenePlanteur (2)

Top Pull Request Authors

  • sbrunato (145)
  • github-actions[bot] (36)
  • jlahovnik (30)
  • alambare-csgroup (19)
  • dalpasso (15)
  • anesson-cs (14)
  • bjgiraudon (9)
  • sandeep-vidyapu (2)
  • leso-kn (1)
  • CGuichard (1)
  • ansotoo (1)

Top Issue Labels

  • enhancement (102)
  • bug (57)
  • dedl (24)
  • server (20)
  • provider (18)
  • documentation (8)
  • priority::1 (3)
  • pending (3)
  • tests (2)
  • priority::0 (1)
  • duplicate (1)

Top Pull Request Labels

  • automated pr (36)
  • enhancement (4)
  • pending (3)
  • provider (2)
  • dedl (2)
  • server (1)
  • bug (1)

Package metadata

pypi.org: eodag

Earth Observation Data Access Gateway

  • Homepage: https://github.com/CS-SI/eodag
  • Documentation: https://eodag.readthedocs.io
  • Licenses: Apache 2.0
  • Latest release: 2.12.0 (published 6 days ago)
  • Last Synced: 2024-02-24T16:32:27.639Z (1 day ago)
  • Versions: 70
  • Dependent Packages: 6
  • Dependent Repositories: 8
  • Downloads: 4,640 Last month
  • Rankings:
    • Dependent packages count: 1.4%
    • Stargazers count: 3.886%
    • Average: 4.246%
    • Downloads: 4.41%
    • Dependent repos count: 5.156%
    • Forks count: 6.378%
  • Maintainers (1)
conda-forge.org: 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.

  • Homepage: https://github.com/CS-SI/eodag
  • Licenses: Apache-2.0
  • Latest release: 2.6.2 (published over 1 year ago)
  • Last Synced: 2024-02-24T16:32:32.847Z (1 day ago)
  • Versions: 14
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Rankings:
    • Dependent repos count: 24.412%
    • Stargazers count: 25.201%
    • Forks count: 32.472%
    • Average: 33.422%
    • Dependent packages count: 51.604%

Dependencies

.github/workflows/deploy.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/fetch.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • peter-evans/create-pull-request v4 composite
.github/workflows/test.yml actions
  • 5monkeys/cobertura-action master composite
  • EnricoMi/publish-unit-test-result-action v2 composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pre-commit/action v3.0.0 composite
docker-compose.yml docker
pyproject.toml pypi
requirements-dev.txt pypi
  • python-dateutil <3.0.0,>=2.1 development
requirements-docs.txt pypi
  • nbconvert >6.3.0
requirements-tutorials.txt pypi
  • xarray >=0.10
requirements.txt pypi
setup.py pypi

Score: 17.620625183744306