Python のインストール - Conda によるインストール


Earth Engine Python API は、Python パッケージと環境マネージャーである conda を介してローカルマシンにインストールできます。Conda は、Anaconda と Miniconda の Python ディストリビューションにバンドルされています。Anaconda は 1, 500 以上のパッケージを含むデータ サイエンス プログラミング プラットフォームですが、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 をインストールする

このセクションでは、Earth Engine API にアクセスするための Python プラットフォームとして機能する Miniconda をダウンロードしてインストールします。上記のように、Miniconda または Anaconda を使用できますが、システムへの影響を最小限に抑えるため、このガイドでは、システムの環境変数を変更しない Miniconda のインストールについて説明します。Anaconda を使用する場合は、こちらに記載されているインストール手順を参照してから、API をインストールするセクションに進んでください。

Miniconda をインストールする

Miniconda のダウンロードとインストールは、次の 3 つの手順で行います。

  1. 64 ビット Python 3 Miniconda インストーラをホーム ディレクトリにダウンロードします。
  2. インストーラを実行する
  3. インストーラを削除する

次の行をコピーして、システムの適切なコマンドライン インターフェースに貼り付けて、これらの手順を完了します。インストールすると、ホーム ディレクトリに「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 変数に追加できます。これにより、完全なパスで activate コマンドを最初に実行しなくても、conda を呼び出すだけで conda を操作できるようになります。次の手順では、Miniconda のインストールをシステムの PATH 変数に追加します。

Linux

以下の GUI またはコマンドラインの手順に沿って、次のパスを「PATH」環境変数に追加します。

$HOME/miniconda3/bin

GUI

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

GUI

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

次のパスを「Path」環境変数に追加します。以下の GUI またはコマンドラインの手順に沿って操作してください。

%UserProfile%\miniconda3\condabin

GUI

1. コマンド プロンプトに次の行を入力して、[環境変数] ダイアログを開きます。

rundll32 sysdm.cpl,EditEnvironmentVariables

2. [ユーザー] セクションの [Path] 変数をダブルクリックして、編集用に選択します。

3. 新しい [編集] ダイアログ ウィンドウで [テキストを編集] ボタンをクリックして、エディタを開きます。

4. 既存の「Path」変数の値の末尾に次の文字列を追加します。セミコロン（;）でエントリを囲み、隣接するエントリと区別します。

%UserProfile%\miniconda3\condabin;

5. すべてのダイアログ ウィンドウが閉じるまで [OK] ボタンをクリックします。

コマンドライン

setx コマンドを使用してパスを追加します。コマンド プロンプトで次のように入力します。

setx Path "%Path%%UserProfile%\miniconda3\condabin;"

conda を初期化する

シェル操作用に conda を初期化します。さまざまなシェルの初期化については、次のコマンドを実行してください。コマンドを入力すると、コンソールに後続の手順が表示されます。

conda init --help

コマンドライン インターフェースを再起動すると、次のコマンドでベースの conda 環境を有効にできます。

conda activate

API をインストールする

Earth Engine Python API は、https://anaconda.org/conda-forge/earthengine-api の conda-forge パッケージとして配布されます。これは conda install コマンドでインストールされます。ただし、インストールする前に、Earth Engine 専用の conda 環境を作成します。Earth Engine API を独自の環境にインストールすると、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 は依存関係をダウンロードしてインストールします。すべてがうまくいけば、API にアクセスするためのすべての要件と earthengine コマンドライン ツールを含む「ee」という名前の conda 環境が作成されます。

認証情報を取得する

Earth Engine API または earthengine コマンドライン ツールを使用する前に、Google アカウントに代わって Earth Engine へのアクセスを承認する 1 回限りの認証を行う必要があります。認証するには、earthengine コマンドライン ツールの authenticate コマンドを使用します。

conda ee 環境内で次のコマンドを実行し、出力された手順に沿って操作します。同意すると、認証コードを生成する URL が提供されます。認証コードをコピーして、コマンドライン入力として入力します。

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 をテストする

DEM データセットのメタデータを出力する簡単な Python スクリプトを実行して、API のインストールをテストします。JSON オブジェクトがコンソールに出力されます。

1. conda ee 環境から python インタープリタを起動します。

python

2. 次の Python 行を 1 行ずつ実行して、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 がシェルで使用するために登録されているかどうかによって異なります。以下で、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 環境を共有する

特に追加の Python パッケージをインストールした場合は、再現可能で複製可能な結果を得るために、conda 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