开源项目安装与配置指南:PlanetLab Notebooks
1. 项目基础介绍
PlanetLab Notebooks
是一个开源项目,它包含了一系列的 Jupyter notebooks,旨在帮助用户使用 Planet 的 API 和工具来探索 Planet 数据,并学习如何从其大量高频卫星图像档案中提取信息。这些互动式的指南适用于软件开发者、数据科学家和开发倡导者,使他们能够提出关于 Planet 数据的有趣问题。
主要编程语言:Python
2. 项目使用的关键技术和框架
- Jupyter Notebook:用于创建和共享代码、文本、方程、可视化和解释性文档的 Web 应用程序。
- Planet API:用于访问 Planet 提供的卫星图像数据的接口。
- Docker:用于容器化应用程序,确保在隔离环境中一致运行。
- Sentinel Hub Python SDK:用于访问 Sentinel 数据的软件开发工具包。
3. 项目安装和配置的准备工作与详细步骤
准备工作
在开始之前,请确保您的系统满足以下要求:
- Docker:用于运行 Jupyter notebooks 的容器。
- Planet 账户和 API 密钥:用于通过 Planet API 访问数据。
安装步骤
步骤 1:克隆项目仓库
打开终端,运行以下命令来克隆仓库:
git clone https://github.com/planetlabs/notebooks.git
cd notebooks
步骤 2:设置 Planet API 密钥
将您的 Planet API 密钥设置为环境变量:
export PL_API_KEY="YOUR-API-KEY"
如果您希望在系统中永久保存 API 密钥,可以将上述命令添加到 ~/.bashrc
或 ~/.zshrc
文件中。
步骤 3:运行 Docker 容器
下载预构建的 Docker 镜像:
docker pull planetlabs/notebooks
docker tag planetlabs/notebooks planet-notebooks
运行容器,并映射您的 API 密钥:
docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan/work -e PL_API_KEY="$PL_API_KEY" planet-notebooks
对于 Windows 用户,可能需要使用 winpty
:
winpty docker run -it --rm -p 8888:8888 -v "/$PWD":/home/jovyan/work -e PL_API_KEY="$PL_API_KEY" planet-notebooks
上述命令将执行以下操作:
- 将 Docker 容器的 8888 端口映射到您的系统的 8888 端口。
- 将当前工作目录映射到 Docker 容器的工作目录,确保您创建的笔记本可用且不会在容器退出时被销毁。
- 设置环境变量,以便在 API 请求中使用您的 Planet API 密钥。
- 启动一个交互式终端,您可以通过
http://localhost:8888
在浏览器中访问。
步骤 4:打开 Jupyter 笔记本
一旦 Docker 容器运行,命令行界面将显示用于通过浏览器访问 Jupyter 笔记本的 URL。通常如下所示:
http://localhost:8888/?token=<UNIQUE-TOKEN>
请注意,每次启动 Docker 容器时,安全令牌都会更改。
按照这些步骤操作,您应该能够成功安装和配置 PlanetLab Notebooks
,开始探索 Planet 数据。