Sentinel Hub Python 包使用教程

Sentinel Hub Python 包使用教程

sentinelhub-py Download and process satellite imagery in Python using Sentinel Hub services. 项目地址: https://gitcode.com/gh_mirrors/se/sentinelhub-py

1. 项目目录结构及介绍

sentinelhub-py/
├── docker/
├── docs/
├── examples/
├── sentinelhub/
├── tests/
├── .gitignore
├── .gitlab-ci.yml
├── .pre-commit-config.yaml
├── .readthedocs.yml
├── CHANGELOG.MD
├── LICENSE.md
├── Makefile
├── README.md
├── pyproject.toml

目录结构介绍

• docker/: 包含与Docker相关的文件，用于容器化部署。
• docs/: 包含项目的文档文件，通常是Markdown或reStructuredText格式。
• examples/: 包含示例代码和Jupyter Notebook文件，展示如何使用该包。
• sentinelhub/: 核心代码库，包含所有Python模块和功能实现。
• tests/: 包含单元测试和集成测试代码。
• .gitignore: Git忽略文件，指定哪些文件和目录不应被版本控制。
• .gitlab-ci.yml: GitLab CI配置文件，定义持续集成和持续部署的流程。
• .pre-commit-config.yaml: 预提交钩子配置文件，用于代码格式化和静态分析。
• .readthedocs.yml: Read the Docs配置文件，用于文档构建和发布。
• CHANGELOG.MD: 项目变更日志，记录每个版本的更新内容。
• LICENSE.md: 项目许可证文件，通常是MIT许可证。
• Makefile: 用于自动化构建和测试的Makefile。
• README.md: 项目主页，包含项目简介、安装说明和基本使用指南。
• pyproject.toml: Python项目配置文件，定义项目依赖和构建工具。

2. 项目启动文件介绍

在 sentinelhub-py 项目中，没有明确的“启动文件”，因为这是一个库项目，而不是一个应用程序。然而，核心功能通常在 sentinelhub/ 目录下的各个模块中实现。

例如，sentinelhub/api.py 文件包含了与Sentinel Hub服务的API交互的核心功能。用户可以通过导入这些模块来使用该库的功能。

from sentinelhub import SentinelHubAPI

api = SentinelHubAPI()
# 使用api对象进行各种操作

3. 项目配置文件介绍

pyproject.toml

pyproject.toml 是Python项目的配置文件，定义了项目的依赖、构建工具和其他元数据。以下是该文件的部分内容示例：

[tool.poetry]
name = "sentinelhub"
version = "3.11.1"
description = "Download and process satellite imagery in Python using Sentinel Hub services"
authors = ["Sentinel Hub Research Team <research@sentinel-hub.com>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.8"
numpy = "^1.19.0"
shapely = "^1.7.0"
# 其他依赖项...

[tool.poetry.dev-dependencies]
pytest = "^6.2.0"
# 其他开发依赖项...

.env

虽然项目中没有明确提到 .env 文件，但用户通常会在使用该库时创建一个 .env 文件来存储敏感信息，如API密钥。

SENTINEL_HUB_API_KEY=your_api_key_here

配置示例

用户可以通过环境变量或直接在代码中配置API密钥：

from sentinelhub import SHConfig

config = SHConfig()
config.sh_client_id = 'your_client_id'
config.sh_client_secret = 'your_client_secret'

以上是 sentinelhub-py 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该开源项目。

sentinelhub-py Download and process satellite imagery in Python using Sentinel Hub services. 项目地址: https://gitcode.com/gh_mirrors/se/sentinelhub-py