インストールガイド

ArcGIS API for Python の環境構築方法を紹介します。

ArcGIS API for Python (以下、Python API) を使用するための環境構築方法は主に 2 つあります。
Python API は、arcgisという名前のパッケージで Anaconda Cloud 等で配布されています。 インストール、バージョン管理には conda が利用されますが、conda は Python のパッケージと環境管理のためのアプリケーションで、 Python API 及び依存するパッケージのインストールやアップデートが可能です。

Python API を使うための環境構築について解説します。

Tips
※ Python API は ArcGIS Pro 経由でインストールするか、Anaconda 経由でインストールする方法がありますが、 PATH の問題を引き起こす可能性があるため、ベストプラクティスとしては、単一のマシンに ArcGIS Pro と Anaconda の両方をインストールすることは推奨されません。

インストールが済みましたら、実行環境である Jupyter Notebook について説明したページ や、更に便利な Jupyter Lab について説明したページ もございますので、併せてご参照ください。

STEP 1:Python API をインストールする

STEP 2:arcgis パッケージをアップグレードする

STEP 3:ArcGIS API for Python を実行する

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


Python API をインストールする

ArcGIS Pro でインストールする

ArcGIS Pro では、2.1 以降のリリースから conda と arcgis パッケージがプリインストールされるようになりました。
ArcGIS API for Python を実行するを試してみましょう。バージョンが最新でない場合はarcgis パッケージをアップグレードするを参照して Python API を更新します。

Anaconda 経由でインストールする

ArcGIS Pro をお持ちでない場合は、Anaconda をインストールします。
Anaconda は Python やパッケージ管理用の conda とその他多くの便利な Python パッケージのインストールやバージョン管理を可能にします。
Python API は Python 3.5 以降を必要とするため、Anaconda ダウンロードページから、適切なバージョンをダウンロードしてください。
※ Python API は、国内では Windows 版のサポートを提供しています。

ターミナルアプリケーション(ここでは Anaconda プロンプト)を開き、次のコマンドを使用して arcgis パッケージをインストールします。

conda install -c esri arcgis

インストールされる Python API のバージョンは基本的に最新バージョンとなります。
インストールが完了したら、ArcGIS API for Python を実行するを試してみましょう。


arcgis パッケージをアップグレードする

ArcGIS Pro 2.3 環境の場合

ArcGIS Pro 2.3 には ArcGIS API for Python 1.5.1 が最初からインストールされています。
ArcGIS Pro をインストールすると、デフォルトで "arcgispro-py3" という読み取り専用の conda 環境が作成されています。Python API を最新のバージョンに更新するには、Python パッケージ マネージャー (ArcGIS Pro の機能のひとつ) を使用して、デフォルトの環境をクローンし、クローンした環境の Python API を最新バージョンにアップグレードします。

  • ArcGIS Pro を起動し、スタートアップ画面の左下にある [設定] をクリックします。
  • [Python]メニューオプションを選択します。
  • [環境の管理]ボタンをクリックし、「環境の管理」ウィンドウを開いて、[デフォルトのクローン]ボタンを選択します。

[環境の管理]ボタンと環境の[デフォルトのクローン]ボタン

  • デフォルト環境のクローンが作成されます。
  • クローンの作成中は下部にインストール中のパッケージ名が表示されます。
    すべてのパッケージのインストールが完了すると、クローンされた環境が格納されているディレクトリ名が表示されます。
    ※完了前に操作をすると、作成した環境が正常に動作しない可能性があります。

クローンの作成中の様子

  • 作成した環境のラジオボタンをクリックして、環境をアクティブにします。
    ここでの操作は、Anaconda で仮想環境をアクティベートする操作に値します。

仮想環境を指定する

  • 環境の管理ダイアログを閉じ、ArcGIS Pro を閉じます
  • Python コマンドプロンプトを開きます。
    スタートメニュー>すべてのプログラム> ArcGIS> Python コマンドプロンプトで開くことができます。
  • 次のコマンドを入力します。

conda upgrade -c esri --no-pin arcgis

コマンドの入力

  • 「Proceed([y]/n)?」 の表示は y を入力して実行します。

インストール、アップグレードするパッケージが表示されるので、問題がなければ"y"を入力します

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

conda list arcgis

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

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

アップデートが完了したら、ArcGIS API for Python を実行するを試してみましょう。

ArcGIS Pro 2.2 環境の場合

ArcGIS Pro 2.2 には ArcGIS API for Python 1.4.1 がインストールされています。
ArcGIS Pro をインストールすると、デフォルトで "arcgispro-py3" という読み取り専用の conda 環境が作成されています。Python API を最新のバージョンに更新するには、Python パッケージ マネージャー (ArcGIS Pro の機能のひとつ) を使用して、デフォルトの環境をクローンし、クローンした環境の Python API を最新バージョンにアップグレードします。

  • 新しい空のプロジェクトで ArcGIS Pro を開きます。
  • [プロジェクト]タブを選択して、ArcGIS Pro の詳細オプションを表示します。(下記のスクリーンショットを参照)
  • [Python]メニューオプションを選択します。
  • [環境の管理]ボタンをクリックしウィンドウを開いて、[新規作成]ボタンを選択します。

[環境の管理]ボタンと環境の[新規作成ボタン]

  • 新しい環境の名前を入力して[保存]を選択します。

[名前]の入力ボックスへ入力する
※日本語は推奨しません。半角英数で入力します。

  • ダイアログの下部にある青色の進行状況バーが消えたら完了です。
    この表示が完了してから、次の操作に進んでください。
    ※完了前の操作は正しい環境が作成・動作しない可能性があります。

青色の進行状況バー

  • 作成した環境のラジオボタンを選択して、環境をアクティブにします。
    ここでの操作は、Anacondaで仮想環境をアクティベートする操作に値します。

仮想環境を指定する

  • 環境の管理ダイアログを閉じ、ArcGIS Pro を閉じます
  • Python コマンドプロンプトを開きます
    またはスタートメニュー>すべてのプログラム> ArcGIS> Python コマンドプロンプトで開きます。
  • 次のコマンドを入力します。

conda upgrade -c esri arcgis

コマンドの入力

  • 「Proceed([y]/n)?」 の表示は y を入力して実行します。

インストールするパッケージ計画が表示され、この計画でよい場合は"y"を選択します

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

conda list arcgis

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

アップデートが完了したら、ArcGIS API for Python を実行するを試してみましょう。

Anaconda 環境の場合

Anaconda プロンプトのようなターミナルアプリケーションを開き、次のコマンドを使用して arcgis を実行してアップグレードします。 conda upgrade -c esri arcgis インストールするパッケージの計画が表示されるので、"y"を選択し、アップグレードします。

アップデートが完了したら、ArcGIS API for Python を実行するを試してみましょう。


ArcGIS API for Python を実行する

Jupyter Notebook を起動する

Windowsの場合

  • スタートメニュー>すべてのプログラム> ArcGIS> Pythonコマンドプロンプトを起動します。
  • cd コマンドを使用して、ノートブックがあるディレクトリ、またはノートブックを作成したいディレクトリに移動します。
  • 次のように入力して jupyter を起動します。

jupyter notebook

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

jupyter notebook

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

Jupyter Notebook で地図を表示してみる

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

  • Windows: Click New > Python 3
  • macOS and Linux: Click New > Python[default]

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

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

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

from arcgis.gis import arcgis
arcgis.__version__

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

インターネットに接続していない環境でも、次の手順で Python API をインストールすることが可能です。 ただし、事前に Anaconda クラウドの ESRI チャネルから、対象の OS と使用している Python のバージョンに適した Python API の最新バージョンのファイルをダウンロードしておきます。

例えば、Windows 64 bit のマシンで、Python 3.7 をお使いの場合は、win-64/arcgis-1.6.0-py37h62639d4_1.tar.bz2 のファイルをクリックし任意の格納先にダウンロードします。

ファイルダウンロード後は、ターミナルアプリケーションを起動して次のコマンドでインストールします。(ファイル格納場所まで移動します)

conda install arcgis-1.6.0-py37h62639d4_1.tar.bz2

"done"が表示されればインストール完了です。

より詳しい情報は 米国Esri ガイドページ:Install and set up をご覧ください

ESRIジャパンが運営する GIS アプリ開発者のためのコミュニティ グループ では、Python API の機能や実際のコードをArcGIS API for Python を使ってみようシリーズブログにてご紹介しています。
GitHub にも日本語による解説付きのコードを公開していますので、是非ご参照ください。