您可以通过 conda(Python 软件包和环境管理器)将 Earth Engine Python API 安装到本地机器。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 未找到或未被识别为命令。该程序可能存在于您的系统中,但未在 PATH 环境变量中注册。即使出现这种情况,为保持一致,请继续阅读安装 conda 部分,因为很难解决所有可能的系统配置问题。只要您的“Home”文件夹中不存在“miniconda3”文件夹,以下 conda 安装说明应该会成功。如需详细了解 conda 安装位置和注册,请参阅 Miniconda 安装和 Anaconda 安装页面。
安装 conda
在本部分中,您将下载并安装 Miniconda,它将用作访问 Earth Engine API 的 Python 平台。如上所述,您可以使用 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
Install API
Earth Engine Python API 以 conda-forge 软件包的形式分发,网址为:https://anaconda.org/conda-forge/earthengine-api。可使用 conda install
命令安装它。不过,在安装之前,请创建一个专门用于 Earth Engine 的 conda 环境。将 Earth Engine API 安装到自��的环境��确保该 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