Earth Engine Python API 可以通过 conda(Python 软件包和环境管理器)安装到本地机器。conda 与 Anaconda 和 Miniconda Python 发行版捆绑在一起。Anaconda 是一个数据科学编程平台,包含 1500 多个软件包,而 Miniconda 仅包含 conda 及其依赖项。这两种 Python 发行版都适合安装和使用 Earth Engine API。如果您不熟悉这些发行版,请访问其链接以了解详情。
本指南将引导您完成以下操作:
- 检查是否已安装 conda
- 在本地机器上安装 conda
- 安装 Earth Engine Python API
- 设置身份验证凭据
- 测试 API
检查是否已安装 conda
如果您的系统上已安装 conda,请跳到 安装 API 部分。如果您不确定是否已安装 conda,请在命令行界面中输入以下命令进行验证。
conda --help
如果已安装 conda 并且其系统路径已在 PATH 环境变量中注册,则 conda 帮助内容应显示在终端中。如果显示帮助内容,请跳到 安装 API 部分。如果无法识别 conda,结果将显示类似以下内容:conda not found or not recognized as a command。该程序可能存在于您的系统上,但未在 PATH 环境变量中注册。即使是这种情况,为了保持一致性,请 继续执行安装 conda部分,因为很难解决所有可能的系统配置。只要您的主文件夹中不存在“miniconda3”文件夹,以下 conda 安装说明就应成功执行。如需详细了解 conda 安装位置和注册,请参阅 Miniconda 安装 和 Anaconda 安装 页面。
安装 conda
在本部分中,您将下载并安装 Miniconda,它将作为 Python 平台来访问 Earth Engine API。如上所述,您可以使用 Miniconda 或 Anaconda,但为了尽量减少对系统的影响,本指南将介绍 Miniconda 安装,而不会更改系统的环境变量。如果您更喜欢 Anaconda,请参阅此处提供的 安装说明 ,然后跳到 安装 API 部分。
安装 Miniconda
下载和安装 Miniconda 分为三个步骤:
- 将 64 位 Python 3 Miniconda 安装程序下载到您的主目录
- 运行安装程序
- 删除安装程序
通过将以下代码行复制并粘贴到适用于您系统的相应命令行界面中来完成这些步骤。安装后,您的主目录中会添加一个名为“miniconda3”的文件夹。
1. 将 Miniconda 安装程序下载到您的主目录。
Linux
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda.sh
Mac
curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh -o ~/miniconda.sh
Windows
powershell -command "Invoke-WebRequest -Uri https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -OutFile ~\miniconda.exe"
2. 以静默方式安装 Miniconda,接受默认设置,并将其安装到您的主目录。
Linux
bash ~/miniconda.sh -b
Mac
bash ~/miniconda.sh -b
Windows
start /B /WAIT %UserProfile%\miniconda.exe /InstallationType=JustMe /AddToPath=0 /RegisterPython=0 /S /D=%UserProfile%\miniconda3
3. 从您的主目录中移除 Miniconda 安装程序。
Linux
rm ~/miniconda.sh
Mac
rm ~/miniconda.sh
Windows
del %UserProfile%\miniconda.exe
测试 Miniconda 安装
打印 conda 命令的帮助菜单以测试 Miniconda 安装。
由于 Miniconda 尚未添加到系统的 PATH 环境变量中,因此您首先需要通过调用 activate 命令(使用其完整系统路径)来为此会话激活 conda。如果测试成功,终端中将显示 conda 帮助内容。在系统的命令行界面中运行以下代码行。
Linux
source $HOME/miniconda3/bin/activate conda --help
Mac
source $HOME/miniconda3/bin/activate conda --help
Windows
%UserProfile%\miniconda3\condabin\activate conda --help
将 Miniconda 添加到 PATH 变量
您可以选择将 Miniconda 安装路径添加到系统的 PATH 变量中,这样您就可以通过简单地调用 conda 来与 conda 交互,而无需先通过其完整路径运行 activate 命令。以下说明将引导您完成将 Miniconda 安装添加到系统的 PATH 变量的过程。
Linux
按照下面的 GUI 或命令行说明,将以下路径添加到“PATH”环境变量中。
$HOME/miniconda3/bin
统一发票
1. 在文本编辑器中打开 $HOME 目录中的 .bashrc 文件。
xdg-open ~/.bashrc
2. 将以下代码行复制并粘贴到文件的底部。
# add path to conda export PATH="$HOME/miniconda3/bin:$PATH"
3. 保存 文件并关闭文本编辑器。
命令行
在终端中输入以下命令,将 conda 路径附加到 ~/.bashrc 文件。
printf '\n# add path to conda\nexport PATH="$HOME/miniconda3/bin:$PATH"\n' >> ~/.bashrc
Mac
按照下面的 GUI 或命令行说明,将以下路径添加到“PATH”环境变量中。
$HOME/miniconda3/bin
统一发票
1. 在文本编辑器中打开 $HOME 目录中的 .bashrc 文件。
touch ~/.bashrc; open -t ~/.bashrc
2. 将以下代码行复制并粘贴到文件的底部。
# add path to conda export PATH="$HOME/miniconda3/bin:$PATH"
3. 保存 文件并关闭文本编辑器。
命令行
在终端中输入以下命令,将 conda 路径附加到 ~/.bashrc 文件。
printf '\n# add path to conda\nexport PATH="$HOME/miniconda3/bin:$PATH"\n' >> ~/.bashrc
Windows
按照下面的 GUI 或命令行说明,将以下路径添加到“Path”环境变量中。
%UserProfile%\miniconda3\condabin
统一发票
1. 在命令提示符中输入以下代码行,以打开“环境变量”对话框。
rundll32 sysdm.cpl,EditEnvironmentVariables
2. 双击“用户”部分下的“Path”变量,以选择该变量进行修改。
3. 在新“修改”对话框窗口中,点击“修改文本”按钮以打开编辑器。
4. 将以下字符串添加到现有“Path”变量值的末尾。确保使用英文分号 (;) 将条目括起来,以将其与相邻条目区分开。
%UserProfile%\miniconda3\condabin;
5. 点击“确定”按钮,直到关闭所有对话框窗口。
命令行
使用 setx 命令附加路径。在命令提示符中输入:
setx Path "%Path%%UserProfile%\miniconda3\condabin;"
初始化 conda
初始化 conda 以进行 shell 交互。运行后续命令,以获取有关各种 shell 的初始化的信息。输入命令后,按照控制台中打印的后续说明进行操作。
conda init --help
重启命令行界面后,您应该能够使用以下命令激活基本 conda 环境。
conda activate
安装 API
Earth Engine Python API 以 conda-forge 软件包的形式分发,网址为:
https://anaconda.org/conda-forge/earthengine-api。
它使用 conda install 命令安装。不过,在安装之前,请专门为 Earth Engine 创建一个 conda 环境。
将 Earth Engine API 安装到自己的环境中可确保它及其依赖软件包不会导致与基本环境或您之前设置的任何其他环境的版本控制问题,反之亦然。如需详细了解如何管理 conda 环境,请
访问 此网站。
1. 激活基本 conda 环境(如果尚未激活)。
Linux
source $HOME/miniconda3/bin/activate
Mac
source $HOME/miniconda3/bin/activate
Windows
%UserProfile%\miniconda3\condabin\activate
2. 为 Earth Engine API 创建 conda 虚拟环境。
conda create --name ee
系统会要求您确认创建环境,请确认。
3. 激活 conda ee 环境。
conda activate ee
4. 将 API 安装到 conda ee 环境中。确保命令行开头显示 (ee),表明您正在 ee 环境中工作。
conda install -c conda-forge earthengine-api
系统会要求您确认安装 API 及其依赖项。确认后,conda 将下载并安装依赖项。如果一切顺利,您现在将拥有一个名为“ee”的 conda 环境
,其中包含访问 API 的所有要求以及
earthengine 命令行工具。
获取凭据
在使用 Earth Engine API 或 earthengine 命令行工具之前,您必须执行一次性身份验证,以授权代表您的 Google 账号访问 Earth Engine。如需进行身份验证,请使用 earthengine 命令行工具中的 authenticate 命令。
在 conda ee 环境中运行以下命令,并按照生成的打印说明进行操作。系统将提供一个网址,该网址在您同意后会生成授权代码。复制授权代码并将其作为命令行输入输入。
earthengine authenticate
输入授权代码后,授权令牌将保存到凭据文件中,该文件可在下方找到。后续使用 API 的 ee.Initialize() 命令和 earthengine 命令行工具时,系统将查找此文件以进行身份验证。如果您想撤消授权,只需删除凭据文件即可。
Linux
ls $HOME/.config/earthengine/credentials
Mac
ls $HOME/.config/earthengine/credentials
Windows
dir %UserProfile%\.config\earthengine\credentials
测试 API
运行一个简单的 Python 脚本,该脚本会打印 DEM 数据集的元数据,以测试 API 安装。它应将 JSON 对象打印到控制台。
1. 从 conda ee 环境启动 python 解释器。
python
2. 逐行运行以下 Python 代码,以打印 DEM 数据集的元数据
import ee # Initialize the Earth Engine module. ee.Initialize() # Print metadata for a DEM dataset. print(ee.Image('USGS/SRTMGL1_003').getInfo())
后续 API 使用
每当您想使用 Earth Engine API 时,都必须先激活 conda ee 环境。激活过程取决于是否已注册 conda 以供在 shell 中使用。请按照下面与您的 conda 安装相关的说明进行操作。
未注册 conda
以下 conda ee 环境激活命令假定已按照上述 安装 conda 部分中的说明安装 conda,即安装路径是根据之前的步骤假定的。在命令行界面中运行以下命令。
Linux
source $HOME/miniconda3/bin/activate ee
Mac
source $HOME/miniconda3/bin/activate ee
Windows
%UserProfile%\miniconda3\condabin\activate ee
已注册 conda
以下 conda ee 环境激活命令假定已按照本指南中的说明或其他方式注册 conda 以供在 shell 或命令提示符中使用。在命令行界面中运行以下命令。
conda activate ee
运行该命令后,您应该会在命令行开头看到 (ee),表明您正在 ee 环境中工作。
现在,您可以启动 Python 解释器并访问 Earth Engine Python API 了。如需有关使用 Python API 的一般指导,请参阅 Python 安装页面。
更新 API
使用 conda update 命令将 ee 环境更新到最新的 API 版本。请记住,如果 conda ee 环境尚未激活,请先激活它。
conda update -c conda-forge earthengine-api
通过打印 ee 库 __version__ 属性,在 Python 中获取当前安装的版本号。在 ee conda 环境命令行中输入 python,然后输入以下命令,以启动 Python 解释器。
import ee print(ee.__version__)
共享 ee 环境
与他人共享 conda Python 环境有助于获得可重现和可复制的结果,尤其是在您安装了其他 Python 软件包时。conda 提供了一种便捷的方式,供他人复制您的环境。
在 conda ee 环境中,运行以下命令以将名为“ee-shared-env”的 YAML 文件保存到您的主目录,该文件列出了您的环境规范。
Linux
conda env export > $HOME/ee-shared-env.yml
Mac
conda env export > $HOME/ee-shared-env.yml
Windows
conda env export > %UserProfile%\ee-shared-env.yml
共享生成的文件,收件人可以通过运行以下 conda 命令来复制环境。
conda env create -f path-to-ee-shared-env.yml
remove 命令
或 conda 的 create 命令的 --clone 标志来管理环境
名称。