インストール ガイド

インストールガイド

Python には、ArcGIS Pro で使用できるパッケージが豊富に用意されています。Python パッケージの使用を簡素化するために、ArcGIS Pro には conda と呼ばれるパッケージ管理システムが含まれています。 conda は、パッケージとその依存関係のインストールや更新の手間を省きます。個のガイドでは ArcGIS Pro を使用したインストールの流れについてご紹介します。

STEP 1: Python API のインストール

ArcGIS Pro でインストール
Python コマンドプロンプトでインストール

STEP 3: ArcGIS API for Python の実行

Jupyter Notebook の起動
Jupyter Notebook で地図表示

Python API のインストール

ArcGIS Pro でインストール

ArcGIS Pro では、2.5 以降のリリースから conda と arcgis パッケージが最初からインストールされています。 conda の機能は、パッケージマネージャーを通じて ArcGIS Pro に統合されています。ArcGIS Pro 2.5 以降では、任意の conda パッケージをダウンロードしてインストールするためのパッケージマネージャーの GUI が提供されています。ArcGIS Pro の設定画面からアクセスすることができます。

ArcGIS API for Python 2.4.0 は ArcGIS Pro 3.4 以降でのみサポートされます。ArcGIS Pro 3.3 以前の環境では、2.4.0 の arcgis および arcgis-mapping パッケージはサポートされません。ArcGIS Pro 3.3.x 環境でのインストールについては、ArcGIS API for Python 2.3.x のドキュメントをご参照ください。

ArcGIS Pro を開き [設定] ＞ [パッケージマネージャー] を選択します。プロジェクトを開いている場合は、[プロジェクト] タブ＞ [パッケージマネージャー] を選択します。
デフォルトの arcgispro-py3 環境にインストールされているパッケージのリストが表示されます。さらにパッケージの追加や更新を行うには、以下の操作を行います。
パッケージマネージャーで [環境マネージャー] ボタンをクリックし、[arcgispro-py3 のクローン作成] ボタンを選択します。

(ArcGIS Pro 3.x)①[環境マネージャー]ボタンと環境の②[デフォルトのクローン]ボタン

必要に応じてパスと名前を変更し、[OK] をクリックします。
すべてのパッケージのインストールが完了すると、クローンされた環境が格納されているディレクトリ名が表示されます。
※ 完了前に操作をすると、作成した環境が正常に動作しない可能性があります。
環境マネージャーウィンドウで作成した環境の右側にある [・・・] から [アクティブ化] を選択し、完了したら [OK] をクリックします。

(ArcGIS Pro 3.x)環境をアクティベート

アクティブ化した環境でインストールされているパッケージを確認したり、更新やパッケージの追加オプションを使用して、クローン環境をニーズに合わせて変更することができます。

パッケージマネージャーを使用して arcgis パッケージをアップグレードすることはできません。arcgis パッケージのアップグレード手順については、「パッケージのアップグレード」のセクションを参照してください。

Python コマンドプロンプトでインストール

ArcGIS Pro には、任意の conda パッケージをダウンロードしてインストールするための Python コマンドプロンプトが提供されています。

Windows のスタートメニュー＞すべてのアプリ＞ ArcGIS ＞ Python コマンドプロンプトを選択します。

デフォルトでは、Python コマンドプロンプトは ArcGIS Pro のデフォルトの arcgispro-py3 環境ディレクトリ(通常は C:\Program Files\ArcGIS\Pro\bin\Python\envs\arcgispro-py3\ ) で開き、デフォルトの conda 環境がアクティブになります。

さらにパッケージを追加するには、デフォルトの arcgispro-py3 環境のクローンを作成する必要があります。Python コマンドプロンプトでクローン環境を作成する手順についての詳細は、Clone a Python environment with the Python Command Prompt を参照してください。クローン環境を既に作成している場合は、以下のコマンドを使用してクローン環境をデフォルトの環境に変更することができます。

proswap <環境名>

Python コマンドプロンプトで以下のコマンドを使用してパッケージをインストールします。
※ バージョン番号を指定しない場合はその時点の最新版がインストールされます。

conda install -c esri arcgis arcgis-mapping

arcgis 2.4.0 および arcgis-mapping パッケージは、ArcGIS Pro 3.4 以降の環境でサポートされています。ArcGIS Pro 3.3.x インストールのパッケージのアップグレードについては、バージョン 2.3.x のドキュメントを参照してください。

Python コマンドプロンプト

arcgis パッケージのアップグレード

デフォルトの arcgispro-py3 環境は変更できません。パッケージをアップデートする場合は、クローン環境を作成してください。また、パッケージマネージャーでは arcgis パッケージを更新することはできません。以下のようにPython コマンドプロンプトを使用します。

Python コマンドプロンプトを開きます。
Windows のスタートメニュー＞すべてのアプリ＞ ArcGIS ＞ Python コマンドプロンプトで開くことができます。
以下のコマンドでアップグレードする arcgis パッケージを含む環境をアクティブ化します。

activate <環境名>

esri チャネルからバージョン番号なしでインストールして、arcgis パッケージを最新版にアップグレードします。以下のコマンドを入力します。

conda install -c esri arcgis arcgis-mapping

コマンドの入力

インストール、アップグレードするパッケージの名前とバージョン番号が表示されるので、問題がなければ y を入力し、実行します。
ArcGIS Pro のバージョンによっては、最新の Python API のバージョンが表示されない場合があります。その場合、一度 n を入力・実行し、以下のコマンドを再入力してください。

conda install -c esri arcgis --no-pin

ArcGIS Pro のバージョンによってはデフォルトの設定で、アップグレードできる Python API のバージョンの上限が指定がされています。
conda install -c esri arcgis --no-pin のうち、--no-pin がバージョンの指定を外して最新版までアップグレードするためのオプションです。
ただし、デフォルトの設定が変更されるわけではないため、アップグレード後に他のパッケージをインストールしようとすると、設定された上限のバージョンにダウングレードするように conda で計画されます。
その場合、そのパッケージをインストールした後に再度上記のコマンドを入力し arcgis パッケージをアップグレードしてください。

アップグレードしたバージョンを確認するには、次のコマンドを入力します。

conda list arcgis

Python API を含む ArcGIS 関連のパッケージとそのバージョン番号が表示されます。

ArcGIS API for Python の実行

Jupyter Notebook の起動

Pythonコマンドプロンプトを起動します。
cd コマンドを使用して、ノートブックがあるディレクトリ、またはノートブックを作成したいディレクトリに移動します。
次のように入力して Jupyter Notebook を起動します。

jupyter notebook

起動しなかった場合は、以下を試してください。

jupyter-notebook

または、スタートメニュー＞すべてのプログラム＞ ArcGIS ＞ Jupyter Notebook を選択しても起動することができます。

Jupyter Notebook の詳しい操作は Jupyter Notebook を使ってみようもご覧ください。
Python API バージョン 1.5.0 以降からは、Jupyter Lab からも操作が可能です。Jupyter Lab を使ってみようも是非ご覧ください。

Jupyter Notebook で地図表示

次の手順で、地図を表示するための新しいノートブックを作成します。

Click New > Python 3

次のコードを入力します。

from arcgis.gis import GIS
my_gis = GIS()
my_gis.map()

Jupyter Notebook から使用している Python API のバージョンを確認する場合、次のコードを実行することで、現在お使いのバージョンを確認することができます。

import arcgis
arcgis.__version__

もしくは、先頭に ! を付けて以下のようにコマンドを実行して確認することも可能です。

!conda list arcgis

参考

オフライン時のインストール方法

インターネットに接続していない環境の場合、次の手順で Python API のインストールが可能です。
ただし、この場合、すべての依存パッケージがインストールされるわけではないため、Jupyter Notebook の利用など、一部の機能が制限される可能性があります (※ 組織やコンテンツの管理など特定のタスクは以下手順でインストールする six パッケージのみで可能です。)
依存パッケージについては米国Esri 社のガイドページ：System requirements を参照ください。

インターネットに接続できる環境で以下の必要なソフトウェアをダウンロードします。

最新の Python 3.x 用の Anaconda
適切なバージョンの Python API のファイル
- Anaconda クラウドの Esri のチャネルからダウンロード可能です。
- ファイル名は以下のパターンに従います
  - OS/arcgis-x.x.x-pyZZyyyyyyy-y.tar.bz2.
    - OS: 使用するマシンの OS
    - x.x.x: API のバージョン
    - ZZ: 使用する Python のバージョン
    - yyyyyyy-y: チャネルにアップロードされた conda のパッケージに付与されるハッシュナンバー
- 例えば、Windows 64 bit のマシンで、Python API 1.6.0 の Python 3.7 版をダウンロードする場合は、"win-64/arcgis-1.6.0-py37h62639d4_1.tar.bz2" をクリックしてダウンロードします。

オフライン環境で Anaconda を設定

Anaconda をインストールします。
次のコマンドでオフラインモードに設定します。

conda config --set offline True

次のコマンドで新しい環境を作成します。

conda create -n <環境名> python six

環境をアクティベートします。

conda activate <環境名>

ArcGIS API for Python をインストールします。

conda install <事前にダウンロードしたファイルのパス>

“done"が表示されればインストール完了です。
より詳しい情報は Esri ガイドページ Install-Offline をご覧ください。

特定の Python 環境のカーネルの追加

異なる Python 環境ごとに Jupyter Notebook のインスタンスを実行する代わりに、特定の Python 環境を持つカーネルを Jupyter Notebook にインストールすることができます。
Jupyter Notebook に特定の Python 環境でカーネルを追加するには、以下で説明する手順に従います。

Python コマンドプロンプトを管理者として実行します
Python コマンドプロンプトウィンドウで、次のコマンドを挿入します

python -m ipykernel install --user --name <環境名> --display-name "<Jupyter Notebook 上の表示名>"

2 のコマンドを実行すると、カーネルが作成され、次の応答が返されます

Installed kernelspec <カーネル名> in C:\Users\<user>\AppData\Roaming\jupyter\kernels\<カーネル名>

次に、別の Python 環境でカーネルを作成するために別の環境をアクティベートします

activate <環境名>

手順 2 と同様の方法でカーネルを作成します
Python コマンドプロンプトで下記のコマンドを入力し、Jupyter Notebook を起動します

Jupyter Notebook

カーネルのリストに作成したカーネルが存在することが確認できます

このような方法で特定の異なる環境のカーネルを作成し、Jupyter Notebook 上で切り替えられるようになります。
特定の Python 環境を持つ新しいカーネルは手動で作成することでも可能です。詳細は Install a new kernel in Jupyter Notebook using a specific Python environment をご参照ください。
また、特定の環境のパスを指定してカーネルを作成する方法については Kernels for different environments もご参照ください。

インストールに関しての詳細は Esri ガイドページ Install and set up もご参照ください。

ArcGIS API for Python のための基礎環境：Conda入門 Jupyter Notebook を使ってみよう