.. eodag documentation master file, created by
sphinx-quickstart on Thu Feb 1 09:22:31 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. role:: raw-html(raw)
:format: html
Earth Observation Data Access Gateway (|version|)
=================================================
:raw-html:``
:raw-html:``
:raw-html:``
:raw-html:``
:raw-html:``
**EODAG (Earth Observation Data Access Gateway) is a command line tool and a Python package for searching and downloading
remotely sensed images while offering a unified API for data access regardless of the data provider.**
|
EODAG gives you an easy way to access products from more than 10 providers, with more than 50 different product
types (Sentinel 1, Sentinel 2, Sentinel 3, Landsat, etc.) that can be searched and downloaded.
.. glossary::
[Growing list of] supported providers
`astraea_eod `_,
`usgs_satapi_aws `_, `earth_search `_,
`earth_search_gcs `_,
`usgs `_, `theia `_,
`peps `_, `aws_eos `_,
`creodias `_, `creodias_s3 `_,
`onda `_, `ecmwf `_,
`cop_ads `_, `cop_cds `_,
`sara `_,
`meteoblue `_,
`cop_dataspace `_,
`planetary_computer `_,
`hydroweb_next `_,
`wekeo `_
EODAG has the following primary features:
* Search and download Earth Observation products from different providers with **a unified API**
* It is both a `Command Line Tool `_ and a `Python Package `_
* It supports `STAC and Static STAC `_ catalogs
* It can run as a `STAC API REST server `_ to give access to a provider's catalog
* New providers can be added with a `configuration file `_ or by extending EODAG with `plugins `_
.. image:: _static/eodag_overview.png
:width: 800
:alt: EODAG overview
:class: no-scaled-link
Example
-------
`Register `_ to one or more providers,
`configure your credentials `_ , and then
downloading *Sentinel 2 Level-1C* products from any provider's catalog is as simple as:
.. code-block:: python
from eodag import EODataAccessGateway
dag = EODataAccessGateway()
search_results, total_count = dag.search(
productType="S2_MSI_L1C",
start="2021-03-01",
end="2021-03-31",
geom={"lonmin": 1, "latmin": 43, "lonmax": 2, "latmax": 44}
)
product_paths = dag.download_all(search_results)
Or:
.. code-block:: bash
eodag search --productType S2_MSI_L1C --box 1 43 2 44 --start 2021-03-01 --end 2021-03-31
eodag download --search-results search_results.geojson
License
-------
EODAG is available under the open source `Apache License`__.
__ https://www.apache.org/licenses/LICENSE-2.0.html
Site contents
-------------
.. toctree::
:maxdepth: 2
:caption: For Users
getting_started_guide/index
api_user_guide
api_reference/index
cli_user_guide
stac
tutos
.. toctree::
:maxdepth: 2
:caption: For Developers/Contributors
add_provider
plugins
contribute
changelog
GitHub Repository