インストール ガイド

ArcGIS API for Python (以下、Python API) を使用するための環境構築は主に 2 つあります。一つは ArcGIS Pro でインストールする方法、もう一つは Anaconda でインストールする方法です。
Python API は、arcgis という名前のパッケージで Anaconda Cloud 等で配布されています。Anaconda Cloud 上のパッケージは conda を使用してインストールやバージョン管理を行うことができます。conda の詳細については ArcGIS API for Python のための基礎環境:conda入門 を参照してください。

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

ArcGIS Pro と Anaconda の違いについては以下のブログもご参照ください。

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 とデータサイエンス向けの Python パッケージなどを提供するプラットフォームです。
Python API は Python 3.5 以降を必要とするため、Anaconda ダウンロードページから、適切なバージョンをダウンロードしてください。
※ Python API は、国内では Windows 版のサポートを提供しています。

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

conda install -c esri arcgis

インストールされる Python API のバージョンは基本的に最新バージョンとなりますが、古いバージョンがインストールされた場合は以下のようにバージョン番号を指定することで指定したバージョンがインストールされます。

conda install -c esri arcgis=1.8.0

Anaconda で Python API の環境構築をした場合、内部ではデータの書き出し等に pyshp を利用しています。2020 年 5 月現在の最新版である pyshp 2.1.0 ではフィールド名が Unicode に対応して日本語が扱えるようになる等、機能が改善されていますが、Python API 1.7.1 以前のバージョンでは古いバージョンの pyshp を使っています。そのため、Anaconda で環境構築する際は 1.8.0 以降の Python API のインストールを推奨します。

インストールが完了したら、ArcGIS API for Python を実行するを試してみましょう。


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

ArcGIS Pro 2.3 以上の環境の場合

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

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

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

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

クローンの作成中の様子

  • 作成した環境のラジオボタンをクリックして、環境をアクティブにします。

環境をアクティベート

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

コマンドの入力

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

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

インストールされるパッケージの確認

  • アップグレードしたバージョンを確認するには、次のコマンドを入力します。
conda list arcgis
  • Python API を含む 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 Prompt のようなターミナルアプリケーションを開き、次のコマンドを使用して arcgis を実行してアップグレードします。

conda upgrade -c esri arcgis

インストールするパッケージの計画が表示されるので、y を選択し、アップグレードします。

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


ArcGIS API for Python を実行する

Jupyter Notebook を起動する

  • Pythonコマンドプロンプト (ArcGIS Pro でインストールした場合)、もしくは Anaconda Prompt (Anaconda でインストールした場合) を起動します。
  • 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

参考

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

インターネットに接続していない環境の場合、次の手順で 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 を設定
conda config --set offline True
  • 次のコマンドで新しい環境を作成します。
conda create -n <環境名> python six
  • 環境をアクティベートします。
conda activate <環境名>
  • ArcGIS API for Python をインストールします。
conda install <事前にダウンロードしたファイルのパス>

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


2. Linux へのインストール

ArcGIS API for Python は Linux マシンにもインストールすることができます。
ここでは、例として Ubuntu Server にインストールする手順をご紹介します。

現在国内では ArcGIS API for Python の Linux での利用は未サポートです。ご利用そのものを妨げるものではありませんが、利用される際は ESRIジャパンの提供するサポート サービス等の対象とならない可能性がある点に留意してください。

Anaconda をインストール

Linux では ArcGIS Pro を利用できないため、Anaconda から ArcGIS API for Python をインストールします。

  • Linux 版の Anaconda の ダウンロード URL を確認し、wget でファイルをダウンロードします
    • ここでは Anaconda 2019.10 for Linux をダウンロードします。
wget https://repo.anaconda.com/archive/Anaconda3-2019.10-Linux-x86_64.sh
  • ダウンロードしたインストーラーを以下のコマンドで実行します。
sh Anaconda3-2019.10-Linux-x86_64.sh
  • インストールするディレクトリは任意のディレクトリを選ぶことができます。ここではデフォルトの設定である、ログイン ユーザーのホーム ディレクトリにインストールすることにします。

変更を反映させるためには一度 シェル を閉じて再度開く必要があります。

arcgis パッケージをインストール

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

Anaconda の base 環境にインストールしてもよいですが、ここでは conda で新しい環境を作成してインストールします。

  • 新しい Python 環境を作成
    • 以下のコマンドで新しい Python 環境を作成します。
    • <環境名> には識別しやすい任意の環境名を指定します。また、ここではインストールする Python のバージョンとして 3.7 を指定しています。
conda create -n <環境名> python=3.7
  • 作成した環境をアクティベート
    • 以下のコマンドで作成した環境に切り替えます
conda activate <環境名>
  • ArcGIS API for Python をインストール
    • 以下のコマンドで ArcGIS API for Python をインストールします。
    • 以下では ArcGIS API for Python 1.7.1 をインストールするよう指定しています。
conda install -c esri arcgis=1.7.1
  • インストールの確認
    • インストールが終了したら以下のコマンドで正常にインストールされているか確認しましょう。
    • 正常にインストールされていれば、arcgis というパッケージ名とインストールしたバージョン番号が表示されます。
conda list arcgis

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