您可以透過 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 not found or not recognized as a command。程式可能存在於系統中,但未在 PATH 環境變數中註冊。即使如此,為確保一致性,請繼續進行「安裝 Conda」一節,因為很難處理所有可能的系統設定。只要主資料夾中沒有「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. 在「User」部分下方,按兩下「Path」變數,選取該變數進行編輯。
3. 在新的「編輯」對話方塊視窗中,點選「編輯文字」按鈕,開啟編輯器。
4. 在現有「Path」變數值的結尾加入下列字串。請務必使用半形分號 (;) 將項目括起來,與相鄰項目區隔。
%UserProfile%\miniconda3\condabin;
5. 按一下「確定」按鈕,直到所有對話方塊都關閉為止。
指令列
使用 setx 指令附加路徑。在命令提示字元中輸入:
setx Path "%Path%%UserProfile%\miniconda3\condabin;"
初始化 conda
初始化 conda,以進行殼層互動。執行後續指令,瞭解各種殼層的初始化資訊。輸入指令後,請按照控制台列印的後續指示操作。
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 已註冊,可透過本指南中的操作說明或其他方式,在殼層或命令提示字元中使用。在指令列介面中執行下列指令。
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
如要在 Python 中取得目前安裝的版本號碼,請列印程式庫的 ee__version__ 屬性。在 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