インストールガイド

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

ArcGIS API for Python を使用するための環境構築方法はいくつかあります。
ArcGIS API for Python(以下、Python API) は、arcgisという名前のパッケージとして配布されています。 conda は Python と Python で使用できるライブラリのインストールやバージョンを管理するパッケージ管理アプリケーションです。

このページでは、conda と arcgis パッケージの両方をインストールする手順について解説します。

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

STEP 2:arcgis パッケージをインストールする

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

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


Conda をインストールする

ArcGIS Pro で conda をインストールする

Anaconda をインストールする

ArcGIS Pro をお持ちでない場合は、Anaconda Distribution (以下、Anaconda)をインストールします。
Anaconda は Python やパッケージ管理用の conda とその他多くの便利な Python パッケージのインストールやパッケージバージョンを管理します。
Python API は Python 3.5 以降を必要とするため、Anaconda ダウンロードページから、Anaconda ソフトウェアの適切な 3x バージョンをダウンロードしてください。

Anaconda がインストールされたら、STEP2 の Anaconda からインストールする へ進みarcgis パッケージをインストールします。


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

ArcGIS Pro の Python パッケージマネージャーからインストールする

ArcGIS Pro 1.4 以降では、Python パッケージ マネージャー(GUI)を使用して、任意の conda パッケージをダウンロードしてインストールできます。 ArcGIS Pro の詳細オプションからアクセスします。

  • 新しい空のプロジェクトで ArcGIS Pro を開きます
  • [プロジェクト]タブを選択して、Pro の詳細オプションを表示します(下記のスクリーンショットを参照)
  • [Python]メニューオプションを選択してください
  • [パッケージの追加]ボタンをクリックし、検索バーに"arcgis"を入力します
  • 利用可能なリリースの完全なリストを確認するには、「更新」ボタンをクリックします。 1.2.5までのリリースをインストールすることができます。 ArcGIS Pro 2.1 の環境でアップグレードするを参照してください
  • [インストール]ボタンを選択します
  • [インストール]をクリックし、利用規約に同意します

※パッケージ名が表示されないなど、この方法がうまくいかない場合は、ArcGIS の Python コマンドプロンプトでインストールすることをお試しください。

ArcGIS の Python コマンドプロンプトでインストールする

ArcGIS Pro 付属の Python コマンドプロンプトを使用してインストールします。

  • スタートメニュー>すべてのプログラム> ArcGIS> Pythonコマンドプロンプト を選択します。
  • 起動した Python コマンド プロンプトで次のように入力します。:

conda install -c esri arcgis

Pro のインストール方法によっては、このプロンプトは管理者権限で起動する必要があります。

Anaconda からインストールする

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

conda install -c esri arcgis

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


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

ArcGIS Pro 2.2 の環境でアップグレードする

ArcGIS Pro 2.2 には ArcGIS API for Python 1.4.1 がインストールされています。
ArcGIS Pro インストール時には "arcgispro-py3" という読み取り専用の conda 環境が作成されています。Python API を最新のバージョンに更新するには、Python Package Manager (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 を実行するを試してみましょう。

ArcGIS Pro 2.1 の環境でアップグレードする

ArcGIS Pro 2.1 には ArcGIS API for Python 1.2.5 がインストールされています。 最新のバージョンに更新するには、arcgispro-py3 環境を有効にしたターミナルウィンドウまたは Python コマンド プロンプトから以下のコマンドを実行します。<

conda upgrade -c esri --no-pin arcgis

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

ArcGIS Pro 1.4 以上と2.0.x と Anaconda の環境でアップグレードする

コマンドプロンプトなどのターミナルまたは Python コマンド プロンプト、Python パッケージ マネージャーを使用してアップデートします。 Python パッケージ マネージャー 以外のコマンドで行う場合は、arcgis パッケージを含む環境を有効にして、次のように入力します。 Anaconda で作成した環境でも同様に、更新対象の Python API が存在する環境を有効にして同じコマンドを使用します。

conda upgrade -c esri arcgis

Python パッケージ マネージャーを使用してアップデートする場合は、次の手順を実行します。

  • 新しい空のプロジェクトで ArcGIS Pro を開く
  • [プロジェク]タブを選択して、ArcGIS Pro の詳細オプションにアクセスします(下記のスクリーンショットを参照)
  • 'Python'メニューオプションを選択してください
  • 適切な環境を選択するには、「プロジェクト環境」ドロップダウンを使用します。
  • [パッケージの更新]オプションを選択します。
  • 最近更新されたパッケージのリストから適切なバージョンのリリースを選択してください
  • [update(更新)]ボタンをクリックして、アップデートしたバージョンを確認します。

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


ArcGIS API for Python を実行する

Jupyter Notebook を起動する

Windowsの場合

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

jupyter notebook

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

macOS and Linux の場合

  • 端末のターミナルを開きます
  • ノートブックがあるディレクトリ、またはノートブックを作成したいディレクトリに変更します
  • 以下を入力してjupyterを起動します

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__

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

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