インストールガイド (Installation)

このページでわかること

項目

内容

ページ種別

ガイド

対象読者

GWexpy を初めて導入する利用者、extras の選び方を知りたい利用者、開発環境を作るコントリビュータ

前提

Python 3.11 以上、pip の基本操作。GW 依存を使う場合は Conda の基本操作

こんなときに読む

最小構成で入れたい、Conda が必要か判断したい、extras の違いを知りたい

検索キーワード

install, pip, conda, extras, PyPI, NDS2, FrameLIB

このページの近道

  • インストールコマンド

  • インストール手順

  • 依存関係トラブルシューティング

  • オプション依存関係 (Extras) の詳細

  • OS 別の注意点

  • セキュリティに関する注意 (Pickle)

  • 次に読む

Note

GWexpy は PyPI に公開されています（最新リリース: v0.1.3）。 conda-forge パッケージは staged-recipes でレビュー中 （https://github.com/conda-forge/staged-recipes/pull/33169）であり、 conda-forge チャンネルにはまだ公開されていません。 conda-forge が利用可能になるまでは、Conda 管理の環境内でも PyPI から インストールしてください。

GWexpy は Python 3.11 以上 をサポートしています。解析の目的に合わせて、いくつかのインストールオプション（extras）を選択できます。

インストールコマンド

目標

インストールコマンド

特徴

最小構成

pip install gwexpy

数値コンテナと基本演算のみ。依存最小。

推奨構成

pip install "gwexpy[analysis,fitting,plotting]"

高度な統計解析、最小二乗法、地図描画など。

重力波解析

pip install "gwexpy[gw,io]"

フレームファイル読み込み、NDS2、公式計算ツール等。

開発 / 全機能

pip install "gwexpy[all]"

GUI を除く宣言済みオプション機能を有効化。

1. インストール手順 (Installation Steps)

最小構成 (Minimal)

依存パッケージを最小限に抑え、ScalarField などの基本フィールド系データ構造だけを利用する場合です。

  • 目的: まず import と基本コンテナだけを試す

  • 入力: Python 3.11 以上と pip

  • 出力: 最小依存の GWexpy 環境

NDS2、FrameLIB、pygmt などのバイナリ依存を使う場合は、この節ではなく コンダ環境 (Recommended / GW Analysis) から始めてください。

pip install gwexpy

開発者モード (For Developers)

ソースコードから最新版をインストールし、テスト環境を構築する場合です。Conda は必須ではありません。 gw 系のバイナリ依存関係まで検証する場合は上の Conda 環境を使い、それ以外のドキュメント修正や通常開発では venv 等の標準的な仮想環境でも構いません。

  • 目的: ローカル clone から編集・テストできる状態にする

  • 入力: Git と Python 仮想環境

  • 出力: pip install -e による編集可能インストール

git clone https://github.com/tatsuki-washimi/gwexpy.git
cd gwexpy
pip install -e ".[dev,all]"

開発者モードは、GWexpy 本体を編集する場合や、未リリースのリポジトリ上の 変更を検証する場合に使ってください。通常利用では上の PyPI 版の導入手順を 推奨します。

2.1. 依存関係トラブルシューティング

  • No module named nds2 が出る場合: python-nds2-client が未導入です。専用の Conda 環境を有効化し、conda install -c conda-forge python-nds2-client を実行してください。

  • FrameLIB / framecpp 系のエラーが出る場合: python-framel と ldas-tools-framecpp を同じ Conda 環境に入れ直してください。

  • 既存の Conda 環境で依存関係が混線した場合: その環境を修復するより、conda create -n gwexpy python=3.11 で作り直す方が安全です。

  • クイックスタート から導入したあとで GW 系のバイナリ依存が必要になった場合: パッケージを場当たり的に足す前に コンダ環境 (Recommended / GW Analysis) に戻ってください。

3. オプション依存関係 (Extras) の詳細

エクストラ名

主要な導入パッケージ

主な用途

analysis

scikit-learn, statsmodels, pmdarima

ノイズ除去、統計予測、機械学習。

fitting

iminuit, emcee, corner

最小二乗法、MCMC 解析。

gw

lalsuite, gwosc, gwinc, ligo.skymap

重力波データ検索、感度計算、スカイマップ描画。

io

nptdms

LabVIEW TDMS 形式の読み込み。

netcdf4

netCDF4, xarray

xarray 経由の NetCDF4 時系列ファイルの読み書き。

zarr

zarr

Zarr array store の読み書き。

plotting

pygmt

高精度な地図投影（GeoMap）。

audio

pydub, tinytag

音声書き出し、オーディオ解析、任意のメタデータ抽出。

seismic

obspy, mth5, mtpy

地震・地磁気データ解析。

control

control (python-control)

制御系モデル・伝達関数解析。

4. OS 別の注意点

  • Linux: 標準的なビルドツール (build-essential) を事前に導入してください。

  • macOS (Apple Silicon): conda-forge チャンネルを利用することで、多くのバイナリが M1/M2/M3 ネイティブで動作します。

  • Windows (WSL2): Windows 本体ではなく、WSL2 上の Linux 環境へのインストールを推奨します。

5. セキュリティに関する注意 (Pickle)

GWexpy は解析結果の共有を容易にするため、Pickle を用いた保存・復元機能をサポートしています。これには 透過 Pickle 技術が使われており、読み込み側に GWexpy がなくても GWpy オブジェクトとして復元できる利便性があります。

Caution

信頼できないソースからの Pickle ファイルをロードしないでください。 Python の pickle モジュールは、ロード時に任意のコードを実行できる脆弱性（Arbitrary Code Execution）を持っています。解析データの授受は、常に信頼できる経路で行うか、HDF5 などのより安全なシリアライズ形式を検討してください。

6. 次に読む