開発版ドキュメント · 0.2.3 30c2f8ba · 入門例の検証対象 0.2.3 · 版情報 · 既知の制限

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

注釈

GWexpy 0.2.3 は PyPI と conda-forge の両方から入手できます。公開されているバージョンは、PyPI、conda-forge、またはリリースページで確認してください。

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

インストールコマンド#

目的	インストールコマンド	主な機能
最小構成 (Minimal)	`pip install gwexpy`	数値コンテナと基本演算のみ。依存最小。
推奨構成	`pip install "gwexpy[analysis,fitting,plotting]"`	高度な統計解析、最小二乗法、地図描画など。
重力波解析	`pip install "gwexpy[gw,io]"`	フレームファイル対応と公式 GW ツール（NDS2 は下記の Conda 手順が必要です）。
開発 / 全機能	`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

コンダ環境 (Recommended / GW Analysis)#

重力波解析（NDS2 や FrameLIB 等）を行う場合は、Conda (Miniforge 等) を使用してバイナリ依存関係を先に解決することを強く推奨します。

この手順は、環境とバイナリ依存関係を Conda で管理する方法です。GWexpy は conda install -c conda-forge gwexpy で導入できます。Conda が必要なバイナリ依存関係を解決した後に PyPI extras を導入することもできます。

警告

Conda 環境を使う場合は、base や別用途の既存環境に直接 pip install せず、GWexpy 専用の新しい環境 を作成してから導入してください。Conda が管理するバイナリ依存関係と pip で追加する Python パッケージを同じ専用環境に閉じ込めることで、環境破損のリスクを下げられます。

目的: NDS2 / FrameLIB などのバイナリ依存を含む GW 解析環境を作る
入力: Conda が使える端末環境
出力: gw extras を含む専用 gwexpy 環境

# 1. Create environment and resolve binary dependencies
conda create -n gwexpy python=3.11
conda activate gwexpy
conda install -c conda-forge python-nds2-client python-framel ldas-tools-framecpp

# 2. Install GWexpy with analysis/fitting options
pip install "gwexpy[gw,analysis,fitting]"

No module named nds2 や FrameLIB 関連の import error が出る場合は、まず上の conda install -c conda-forge ... を専用環境で再実行してください。NDS2 や FrameLIB を使わない場合は、gw extras を外した最小構成または推奨構成で十分です。

開発者モード (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. 依存関係トラブルシューティング#

No module named nds2、FrameLIB / framecpp の import エラー、環境が混線した場合の修復については、トラブルシューティングを参照してください。より詳しい対処法をまとめています。

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

3. Optional Dependencies (Extras) Details#

エクストラ名	主要な導入パッケージ	主な用途
`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-Specific Notes#

Linux: 標準的なビルドツール (build-essential) を事前に導入してください。
macOS (Apple Silicon): conda-forge チャンネルを利用することで、多くのバイナリが M1/M2/M3 ネイティブで動作します。
Windows (WSL2): Windows 本体ではなく、WSL2 上の Linux 環境へのインストールを推奨します。

5. Security Note (Pickle)#

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

注意

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

6. Next to Read#

クイックスタート - 最小コードで import と描画を確認する
トラブルシューティング - インストール・描画・バイナリ依存の問題を症状から逆引きする
はじめに - インストール後の学習順序を決める
前提条件と規約 - FFT・GPS 時刻・GWpy 互換性の前提を確認する