インストール ガイド

インストールガイド

出典：ArcGIS API for Python - Install and set up - ArcGIS Pro

Python には、ArcGIS Pro で使用できる豊富なパッケージが用意されています。Python パッケージの使用を簡素化するため、ArcGIS Pro には conda と呼ばれるパッケージ管理システムが組み込まれています。conda を使用することで、パッケージやその依存関係のインストールや更新に伴う手間を省くことができます。 Python パッケージの汎用性と実用性をさらに高めるため、1 台のワークステーション上で複数の Python 環境を互いに独立して共存させることができます。これらの各インストール環境は、Python 環境と呼ばれます。各 Python 環境には独自のパッケージセットを保持できるため、毎回パッケージをアンインストールしたり再インストールしたりすることなく、Python の機能セットを切り替えることができます。デフォルトでは、ArcGIS Pro には arcgispro-py3 という単一の conda 環境が用意されており、これには ArcGIS Pro で使用されるすべての Python ライブラリーに加え、scipy や pandas などのいくつかのライブラリーも含まれています。

クローンされた ArcGIS Pro 環境において、ArcGIS API for Python 2.4.x のリリースは、ArcGIS Pro 3.4 以降でのみサポートされます。2.4.2 の arcgis および arcgis-mapping パッケージは、クローンされた ArcGIS Pro 3.3 およびそれ以前の環境ではサポートされていません。 ArcGIS Pro 3.3.x のクローン環境へのインストールにおいてサポートされる最新のバージョンは 2.3.x です。Pro 3.3.x へのインストールについては、API 2.3.x の手順を参照してください。

Python パッケージマネージャーを使用したインストール
Python コマンドプロンプトを使用したインストール
arcgis パッケージのアップグレード
インストールの確認
参考
- オフライン時のインストール方法
- 特定の Python 環境のカーネルの追加

Python パッケージマネージャーを使用したインストール

Python パッケージマネージャーにより、Python コードを記述する際に直面する多くの課題が解消されます。このマネージャーは、Python の基本インストール環境ではなく、個々のプロジェクトに関連付けられたオープンソースやサードパーティのライブラリのインストールをサポートしています。これにより、複雑な Python ツールを複数のコンピュータ間で円滑に共有するプロセスが簡素化されます。

ArcGIS Pro では、2.5 以降のリリースから conda と arcgis パッケージが最初からインストールされています。 conda の機能は、パッケージマネージャーを通じて ArcGIS Pro に統合されています。Python パッケージマネージャーにより、Python コードを記述する際に直面する多くの課題が解消されます。このマネージャーは、Python の基本インストール環境ではなく、個々のプロジェクトに関連付けられたオープンソースやサードパーティのライブラリのインストールをサポートしています。これにより、複雑な Python ツールを複数のコンピュータ間で円滑に共有するプロセスが簡素化されます。

ArcGIS Pro 2.5 以降では、任意の conda パッケージをダウンロードおよびインストールするための Python パッケージマネージャーの GUI が提供されています。ArcGIS Pro の設定画面からアクセスできます。

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

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

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

(ArcGIS Pro 3.x) 環境をアクティブ化

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

Python パッケージマネージャーを使用して 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 API for Python の最新リリースにアップグレードされます。

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

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

ArcGIS Pro 環境では、arcgis パッケージはパッチリリースへのみアップグレードできます。たとえば、ArcGIS Pro にインストールされている arcgis パッケージが 2.4.1 の場合、クローン環境では 2.4.1.x シリーズのリリースのみにアップグレードできます。

Python コマンドプロンプトを開きます。
Windows のスタートメニュー＞すべてのプログラム＞ ArcGIS ＞ Python コマンドプロンプトで開くことができます。
以下のコマンドでアップグレードする arcgis パッケージを含む環境をアクティブ化します。
```
activate <環境名>
```
esri チャネルから、以下のコマンドでパッチリリース番号を指定してインストールし、arcgis パッケージをパッチリリースにアップグレードします。
```
conda install -c esri arcgis=<パッチ リリース番号> arcgis-mapping
```

コマンドの入力

インストール、アップグレードするパッケージの名前とバージョン番号が表示されるので、問題がなければ y を入力し、実行します。

バージョン番号を指定して、互換性のある特定の arcgis リリースをインストールすることができます。

conda install -c esri arcgis=<バージョン番号> arcgis-mapping=<バージョン番号>

インストールの確認

出典：ArcGIS API for Python - Install and set up - Test your install

arcgis パッケージのインストール状況を確認するには、Juptyter Notebook や Jupyter Lab（Lab 4.x または Notebook 7.x）で以下のコマンドを実行してください。 Jupyter Notebook の操作については Jupyter Notebook を使ってみようをご参照ください。

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

ディープラーニング環境を確認するには、以下のコマンドを実行してください。

import fastai
import torch
import arcgis

GPU 上でモデルを学習する際に、CUDA デバイスが認識されているかどうかを確認するには、このコマンドを実行してください。

torch.cuda.is_available()
torch.zeros((3, 224, 224)).cuda()

ドライバーに関する問題を示すエラーが発生した場合は、ドライバーを更新する必要があります。

ArcGIS API for Python のドキュメントでは、ArcGIS API for Python を使用して、マッピング、クエリー、分析、ジオコーディング、ルート検索、ポータル管理などの機能を組み込んだ Python コードを作成する方法について説明しています。まずはサンプルノートブックをご覧ください。これらのサンプルノートブックは ArcGIS Notebooks として利用可能なので、実際の環境で試してみることもできます。

これらは一時的な環境であり、ブラウザーのタブを閉じると消去されます。変更内容を保存したい場合は、Jupyter Notebook、Juptyter Lab の File メニューからノートブックをダウンロードしてください。

参考

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

出典：ArcGIS API for Python - Install and set up - Offline

オフライン環境で ArcGIS API for Python をインストールする方法をご紹介します。ここでは、conda を使用してオフライン環境で ArcGIS API for Python をインストールする手順です。

ArcGIS Pro や ArcGIS Enterprise などの Esri 製品で使用するために -c esri チャネルを使用してパッケージをインストールするユーザー、および Esri の環境で使用するためのアプリケーションをデプロイするユーザーは、現行のすべてのライセンスの対象となります。外部環境にアプリケーションをデプロイする場合、または Anaconda のリポジトリーやコンポーネントをミラーリングする場合は、Anaconda ベースパッケージの使用をカバーするために、追加の Anaconda ライセンスが必要となります。詳細については、Esri と Anaconda のライセンス契約を参照してください。

1. ソフトウェアのダウンロード

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

お使いの OS に対応した、Python 3.x 用の Anaconda または Miniconda の最新バージョン
- Anaconda
- Miniconda
ターゲットプラットフォームに対応した Python パッケージ用の API の適切なバージョンとその依存関係。現在サポートされているターゲットプラットフォームは以下の通りです
- Windows 64-bit (win-64)
- Linux 64-bit (linux-64)
- macOS Intel (osx-64)
ソース (接続先) 環境がターゲットプラットフォームとは異なるプラットフォームである場合
- CONDA_SUBDIR 環境変数を、ターゲットとなる (接続されていない) プラットフォーム (win-64、linux-64、または osx-64) に設定してください。例 :
  - Bash : export CONDA_SUBDIR=win-64
  - PowerShell : $env:CONDA_SUBDIR="linux-64"
  - cmd : set CONDA_SUBDIR=linux-64
ダウンロード用の空のディレクトリを作成します。例 :
- Windows : mkdir C:\Users\me\Downloads\arcgis_offline
- macOS : mkdir ~/Downloads/arcgis_offline
CONDA_PKGS_DIRS 環境変数を、前の手順で作成した空のダウンロードディレクトリに設定します。例 :
- Bash : export CONDA_PKGS_DIRS=~/Downloads/arcgis_offline
- PowerShell : $env:CONDA_PKGS_DIRS="C:\Users\me\Downloads\arcgis_offline"
- cmd : set CONDA_PKGS_DIRS=C:\Users\me\Downloads\arcgis_offline
ArcGIS API for Python およびその依存関係をダウンロードするには、次のコマンドを実行してください。
```
conda create --name arcgis_offline --override-channels --download-only -c esri -c defaults arcgis arcgis-mapping
```
- arcgis および arcgis-mapping の特定のバージョンをダウンロードするには、次のコマンドを実行してください。
```
conda create --name arcgis_offline --override-channels --download-only -c esri -c defaults arcgis=<release_number> arcgis-mapping=<release_number>
```

arcgis-mapping は、arcgis バージョン 2.4.0 以降でのみサポートされています。

次のようなメッセージが表示される場合があります。これは、ダウンロードが正常に完了したことを示しています。

CondaExitZero: Package caches prepared. UnlinkLinkTransaction canceled with --download-only option

ダウンロードディレクトリ内のすべてのファイル (サブディレクトリはスキップしても構いません) を、オフライン環境にコピーしてください。詳細は以下をご覧ください。

すべての .conda ファイルや .tar.bz2 ファイルに加え、URL および urls.txt を必ず含めることが重要です。

2. Anaconda の設定

オフライン環境内で、Anaconda をインストールしてください。インストールが完了したら、Anaconda Navigator GUI アプリケーションまたは Anaconda Prompt コマンドラインコンソールを使用して、ソフトウェアを操作できます。以下の手順では、Windows での Anaconda Prompt および conda ユーティリティーの使用方法について説明します。

まず、Start > Anaconda3 (64-bit) > Anaconda Prompt で Anaconda Prompt を開きます。以降のコマンドはすべて、このプロンプト内で実行します。

Anaconda をオフラインで使用できるように設定します。詳細については、Conda Configuration を参照してください。
```
conda config --set offline True
```
オフライン環境にあるパッケージキャッシュディレクトリを取得します。
```
conda config --show pkgs_dirs
```
接続先の環境から、前の手順で指定したキャッシュ　ディレクトリのいずれかにファイルをコピーしてください。
新しい空の環境を作成します。
```
conda create -n <my_env_name>
```
環境をアクティブ化します。
```
conda activate <my_env_name>
```

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

conda install python --offline --use-local

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

conda install arcgis arcgis-mapping --offline --use-local

3. インストールの確認

現時点では、マップウィジェットを除くすべてのモジュール、クラス、関数が API として利用可能であり、Python スクリプトや Jupyter Notebook で使用できます。GIS に接続してプロパティを出力することで、インストールが正常に行われたかを確認できます。

gis = GIS("url_to_your_gis", "username", "password")
print(f"Connected to {gis.properties.portalHostname} as {gis.users.me.username}")

マップウィジェットは、Jupyter アプリケーション内でのみサポートされています。オフライン環境でマップウィジェットを使用するには、以下の追加手順に従ってください。

ArcGIS Maps SDK for JavaScript をローカルにインストールします。
- ArcGIS API for JavaScript SDK のダウンロードページはこちら。
- ダウンロードが完了したら、ArcGIS Maps SDK for JavaScript をローカルでホストします。手順の詳細はこちらを参照してください。

使用しているマップウィジェットの対応バージョンは、次のコードで確認できます。

from arcgis.map import Map

m = Map()
m.js_requirement()

'This version of arcgis-mapping requires the ArcGIS Maps SDK for JavaScript version 4.33. You can download it from https://developers.arcgis.com/javascript/latest/downloads/ .'

JavaScript のインストール手順に従って MIME 型を追加した後、JavaScript を完全に機能させるために、以下のヘッダーを追加する必要がある場合があります。
- Access-Control-Allow-Credentials
- Access-Control-Allow-Origin

手順はご利用の環境によって異なります。設定の詳細については、CORS with the SDK もご参照ください。

JS_API_CDN 環境変数を、お使いのローカルの JavaScript インストール先に設定してください。

import os
CDN_Path = "http://<local_path>/arcgis_js_api/javascript/4.33/"
os.environ["JSAPI_CDN"] = CDN_Path

Web GIS では、位置情報が初期設定された地図を表示するために、ユーティリティーサービスとして Geocoder が設定されている必要があります。詳細については、住所をジオコーディングするための組織の構成およびユーティリティーサービスの構成を参照してください。

pixi を使用したオフライン環境でのインストールについては Pixi steps をご参照ください。

特定の 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 を使ってみよう