.. |binder-badge| 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

.. |license-badge| image:: https://img.shields.io/pypi/l/eodag.svg :target: https://pypi.org/project/eodag/

.. |versions-badge| image:: https://img.shields.io/pypi/pyversions/eodag.svg :target: https://pypi.org/project/eodag/

|license-badge| |versions-badge|

请查看 EODAG Jupyterlab 扩展: eodag-labextension <https://github.com/CS-SI/eodag-labextension>_! 它为您的笔记本提供了友好的用户界面,帮助您使用 eodag 搜索和浏览地球观测产品。

EODAG(地球观测数据访问网关)是一个命令行工具和面向插件的Python框架,用于搜索、聚合结果和下载遥感图像,同时为数据访问提供统一的API,而不受数据提供商的限制。EODAG SDK围绕三个功能构建:

列出产品类型:支持的产品列表及其描述
搜索产品(按产品类型或uid):根据提供的搜索条件搜索产品
下载产品:"原样"下载产品

EODAG 用 Python 开发。它根据模块化插件架构构建,易于扩展并能够集成新的数据提供商。该工具由三种类型的插件组成:

目录搜索插件,负责搜索数据(OpenSearch、CSW 等)、构建路径、检索快速查看、组合结果
下载插件,允许下载数据并将其本地检索(通过 FTP、HTTP 等),始终使用相同的目录组织
身份验证插件,用于在使用的外部服务上对用户进行身份验证(JSON Token、Basic Auth、OAuth 等)。

从 v2.0 开始,EODAG 可以作为 STAC 客户端或服务器 <https://eodag.readthedocs.io/en/latest/stac.html>_ 运行。

阅读 文档 <https://eodag.readthedocs.io/en/latest/>_ 以获取更多见解。

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

安装

EODAG 可在 PyPI <https://pypi.org/project/eodag/>_ 上获得:

.. code-block:: bash

python -m pip install eodag

也可以通过 conda 从 conda-forge 频道 <https://anaconda.org/conda-forge/eodag>_ 安装:

.. code-block:: bash

conda install -c conda-forge eodag

[!重要]

v3.0.0 中的重大变更: 请注意,EODAG 带有最小依赖集。如果您想要更多功能,请使用 可用的额外选项 <https://eodag.readthedocs.io/en/latest/getting_started_guide/install.html#optional-dependencies>_ 进行安装。

用法

要下载,您需要在 eodag 用户配置文件 <https://eodag.readthedocs.io/en/latest/getting_started_guide/configure.html>_ 中填写所需提供商的凭据。该文件将在首次运行时自动创建,其中包含空值。

Python API

在 Python 代码中与 API 交互的示例用法:

.. code-block:: python

from eodag import EODataAccessGateway

dag = EODataAccessGateway()

search_results = dag.search(
    productType='S2_MSI_L1C',
    geom={'lonmin': 1, 'latmin': 43.5, 'lonmax': 2, 'latmax': 44}, # 接受 WKT 多边形、shapely.geometry 等
    start='2021-01-01',
    end='2021-01-15'
)

product_paths = dag.download_all(search_results)

这将在默认提供商上搜索 Sentinel 2 level-1C 产品,并返回找到的产品的第一页以及估计的符合搜索条件的产品总数。然后它将下载这些产品。请查看 Python API 用户指南 <https://eodag.readthedocs.io/en/latest/api_user_guide.html>_ 以获取更多详细信息。

[!重要]

v3.0.0 中的重大变更: search() <https://eodag.readthedocs.io/en/latest/api_reference/core.html#eodag.api.core.EODataAccessGateway.search>_ 方法现在只返回单个 SearchResult,而不是包含 2 个值的元组。

STAC REST API

可以通过命令行将 eodag 实例作为符合 STAC 的 REST API 公开(需要 eodag[server]):

.. code-block:: bash

$ eodag serve-rest --help
用法: eodag serve-rest [选项]

  启动 eodag HTTP 服务器

  设置 EODAG_CORS_ALLOWED_ORIGINS 环境变量以配置跨源资源共享允许的源,
  作为逗号分隔的 URL(例如 'http://somewhere,htttp://somewhere.else')。

选项:
  -f, --config PATH   用户配置文件的文件路径,其中包含凭据,
                      默认为 ~/.config/eodag/eodag.yml
  -l, --locs PATH     位置 shapefile 配置文件的文件路径
  -d, --daemon        以守护进程模式运行
  -w, --world         使用 IPv4 0.0.0.0(所有网络接口)运行 uvicorn,
                      否则绑定到 127.0.0.1(localhost)。
  -p, --port INTEGER  要监听的端口  [默认: 5000]
  --debug             以调试模式运行(用于开发目的)
  --help              显示此消息并退出。

# 运行服务器
$ eodag serve-rest

# 列出 ``peps`` 提供商的可用产品类型:
$ 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"

# 搜索项目
$ 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

# 浏览项目
$ 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

# 获取下载链接
$ 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"

# 下载
$ 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 可在 https://hub.docker.com/r/csspace/eodag-server <https://hub.docker.com/r/csspace/eodag-server>_ 上获得:

.. code-block:: bash docker run -p 5000:5000 --rm csspace/eodag-server:3.0.0b3

你还可以使用 STAC Browser <https://github.com/radiantearth/stac-browser>_ 浏览你的STAC API服务器。只需运行：

.. code-block:: bash

git clone https://github.com/CS-SI/eodag.git
cd eodag
docker-compose up
# 或者使用更详细的日志记录：
EODAG_LOGGING=3 docker-compose up

然后在浏览器中访问 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 示例 :width: 600px

更多信息，请参阅 STAC REST API 使用说明 <https://eodag.readthedocs.io/en/latest/stac_rest.html>_。

命令行界面

开始使用命令行界面：

搜索产品::

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

上述请求在给定的边界框内搜索2021年3月的 S2_MSI_L1C 产品类型。它将结果保存在GeoJSON文件中（默认为 search_results.geojson）。

结果是分页的，你可以使用 --all 一次性获取所有页面，或者使用 --cloudCover 20 搜索云覆盖率不超过20%的产品。更多可用选项信息，请运行::

eodag search --help
下载上次搜索结果::

eodag download --search-results search_results.geojson
仅下载上次搜索结果的快速预览图::

eodag download --quicklooks --search-results search_results.geojson
列出所有可用的产品类型和支持的提供商::

eodag list
列出指定提供商支持的可用产品类型::

eodag list -p creodias
查看所有可用选项和命令::

eodag --help
打印日志信息，在eodag主命令后添加 -v。例如 eodag -v list。添加的 v 越多（最多3个），工具输出的信息越详细。要获得完整的详细输出，可以执行：eodag -vvv list