PyGMTの環境構築

PyGMTの環境構築#

Google Colab 上での利用#

手軽にPyGMTを試すためには，Google Colabを利用するのがよいでしょう．Google ColabはGoogleが機械学習の教育及び研究用に提供しているもので，Googleアカウントさえあればクラウド上でJupyter Notebookを実行できます．大量の計算リソースを使うためには有料のサービスもありますが，本Webページで示しているくらいの可視化を行う程度の基本的な利用は無料です．

Google Colabには，機械学習等で使われる標準的なパッケージはあらかじめ含まれているのですが，残念ながらPyGMTは含まれていません．すでに多くの関連Webでも紹介されていますが（例えばPyGMT開発メンバーの@seisman 氏のGMT Forum, @after-a-rain 氏のQiita記事や@mim 氏のnote記事など），比較的容易にインストールすることができます．

import sys
if 'google.colab' in sys.modules:
    print("Installing pygmt on Google Colab. It may take a few minutes.")
    ! pip install -q condacolab &> /dev/null
    import condacolab
    condacolab.install()
    ! mamba install pygmt &> /dev/null

上記のコードは，Google Colabで実行したときにだけPyGMTをインストールするためのコードです．それ以外の環境では実行されないようにもなっています．これをColab上のノートブックのセルに貼り付けて実行するか，あるいはこちらのリンクからサンプルのノートブックを開くことでも実行できます．

Note

インストールには約2分ほどの時間かかります．インストール時にカーネルがクラッシュした旨のメッセージが出ることがありますが，そのまま進めて特に問題はなさそうです．

また，Google Colabの仕様により，この方法でインストールしたPyGMTは，そのセッション限りで有効です．そのため，毎回セッションを開始するたびに上記のコードを実行する必要があります．毎回のインストール作業が鬱陶しいようであれば，以下の節で説明するローカル環境へのインストールをお勧めします．

ローカル環境へのインストール#

Warning

本節の記述はmacOS Sequoia 15.2およびLinuxディストリビューションの一種であるUbuntu 24.04LTSで動作確認しています．Windows OSにおいてもWSL2を用いることでUbuntuをはじめとしたLinuxディストリビューションを容易に利用可能なはずです（未確認）．

PyGMTを使うための環境構築には，Pythonのパッケージ管理システムである

のどちらかを使います．原理的には自分でソースコードから構築することもできるはずですが，PyGMTはそれを動作させるための依存ライブラリがとても多いため，パッケージ管理システムを使うことを勧めます．

pipはPythonに付属したツールで，Python上で用いるライブラリの管理を行うものである一方，condaはPythonの処理系自体を含むパッケージで，Pythonのみならずそれに（広い意味で）関連した様々なツールをインストールできます．

どちらを使うかは好みの問題だと思いますが，PyGMTについてはcondaのほうが比較的に容易に環境が構築できるようです．ただし，condaはライセンスまわりにやや注意が必要です．

Anacondaライセンス問題とMiniforgeの利用#

conda コマンドはもともとAnacondaという科学技術計算に必要なライブラリが多く含まれたPython実行環境とそのパッケージ管理システムの一部でした．Anacondaをインストールするだけで一通りの計算環境が揃うためたいへん便利なものだったのですが，2020年4月より利用規約が改定となり，大規模な商用利用は有償になりました．その時点では大学関係者や非商用利用に関してはこの条件は適用されないと明記されていたのですが，その後さらにライセンス条件が変更され，2024年現在，事実上Anacondaの無償利用は困難な状況になったようです．

そこで，ここではPythonおよびパッケージ管理コマンドのcondaを含むコミュニティベースのパッケージ管理システムであるminiforgeを利用し，PyGMTの環境を構築します．

Warning

以前，このページではMinicondaとコミュニティベースのリポジトリである conda-forge の利用を推奨し，その方法について説明していました．しかしMinicondaはデフォルトの状態ではAnaconda本体のリポジトリを利用する設定となっているため，そのままではライセンスに抵触するおそれがあります．そこで，今後はコミュニティリポジトリのconda-forgeをデフォルトで使いつつ，従来のcondaと同じ使い方のできるMiniforgeの利用を推奨します．

Miniforgeのインストール#

まずは適当なディレクトリで，miniforgeをダウンロードします．ここではcurlコマンドを使った例を示します．

$ curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"

Note

行頭の $ はシェルのプロンプトです．コマンドそのものには含まれませんのでご注意ください．

ダウンロードしたら，そのスクリプトを bash コマンドで実行します．

$ bash Miniforge3-$(uname)-$(uname -m).sh

あとは対話的に y/n を選んでいくことでMiniforgeインストールできます．その際，インストール先も指定できます．デフォルトは~/miniforge3のはずです．ただし~は自分のホームディレクトリを意味します．インストール時にnoと答えていなければ，自分のシェル設定ファイル（.bashrcあるいは.zshrc）にcondaコマンドを実行するための初期設定が書き込まれます．これにより，次回端末（あるいはシェル）起動時より，ターミナルのプロンプトに (base) と表示されるはずです．これはcondaのbase仮想環境（標準状態）であることを意味します．

これでインストール作業は終わりですが，conda自体を最新版にアップデートしておきましょう．

conda update conda

仮想環境の作成とPyGMTのインストール#

このままデフォルトの環境にパッケージを追加していってもよいのですが，ここではPyGMT用の仮想環境を作成します．このようにすると，パッケージ間のバージョン不整合などのトラブルがあったときに，仮想環境ごと切り替えるということが可能になります．ここでは，本Webサイトで利用するパッケージをまるごと導入する仮想環境pygmtを作ってみましょう．ここでは，2023年12月時点で最新となるPyGMT v0.13.0と，GMT v6.5.0 を導入します．

$ conda create --name pygmt \
  pygmt==0.13.0 gmt==6.5.0 numpy scipy obspy==1.4.1 notebook matplotlib ffmpeg

Note

コマンドが長いため \で適宜改行しています．仮想環境の名前 pygmt はお好みで適宜変更するとよいでしょう．

上記のコマンドでは，まず --name オプションで仮想環境の名前を宣言し，そのあとでインストールする各種パッケージと必要に応じてそのバージョンを == でつないで表現しています．PyGMTのほか，科学技術計算に必要なNumPyやSciPy，地震学データ解析に用いるObsPy，実行環境としてJupyter Notebook(notebookがそれにあたります）などをまとめてインストールします．

上記コマンドからわかるように，conda ではPythonのライブラリだけではなく，GMTそのものもインストールされます．ですから，この環境構築方法では，GMTを別途インストールしておく必要はありません．今回作成した仮想環境のbashから，GMT自体も使うことができます．また，Python本体も指定したバージョンのものがインストールされます．ライブラリやPythonのバージョン番号は指定しなければ最新版が入ります．

Tip

これらのライブラリや実行バイナリは，miniforge のインストールディレクトリ下の envs ディレクトリに格納されます．miniforgeをデフォルトでホームディレクトリにインストールしている場合，容量の増大にはご注意ください．

インストールが完了したら

conda activate pygmt

により仮想環境を有効化します．すると，プロンプトの左側の (base) が仮想環境の名前 (pygmt) に変わります．もしいつでもこの環境を使いたいならば，シェルの初期設定ファイル（.bashrc あるいは .zshrc など）に上記の activate コマンドを記載しておくとよいでしょう．

一方，仮想環境から抜けるには

conda deactivate

です．もしこの仮想環境が不要になって削除したいときは，仮想環境からconda deactivate した状態で

conda remove -n pygmt --all

とします．

Contents