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

前提条件と規約#

このページは、GWexpy のガイドやチュートリアルを読む前に把握しておきたい共通の前提条件と規約をまとめたページです。 個別アルゴリズムの仮定や数式の詳細は各ページに記載し、このページでは「どこを先に確認すべきか」を案内します。

1. Environment Prerequisites#

  • 基本的な利用環境は Python 3.11 以上 を前提にしています。

  • 最低限の前提知識は、Python の基礎、NumPy 配列操作、必要に応じて Matplotlib です。

  • オプション依存パッケージを導入すると追加機能が利用できます。セットアップの詳細は インストールガイド を参照してください。

全体の最短学習経路をまず知りたい場合は、はじめに から始めてください。

2. Data and Time Assumptions#

  • GWexpy は gwpy 系の時系列・周波数系列コンテナとの互換性を重視しています。

  • 時刻の扱いでは GPS 時刻 を前提とする API があります。特に ARIMA 予測時刻などは UTC の閏秒系と混同しないでください。

  • ファイル形式によっては絶対時刻を保持しません。たとえば音声形式は t0=0.0 を便宜的に使う場合があります。

  • ローカルの壁時計時刻のみを保持する形式では、明示的な timezone の指定が必要になる場合があります。代表例は ファイル I/O 対応フォーマットガイド の GBD です。

アルゴリズムごとの仮定まで確認したい場合は 検証済みアルゴリズム を参照してください。

3. FFT and Spectral Conventions#

  • GWexpy では、FFT の正規化、片側/両側スペクトル、符号規約を明示的に扱います。

  • fft_time と fft_space では、対象軸と正規化の考え方が異なります。

  • spectral_density では PSD と spectrum の意味を区別して扱います。

各スペクトル手法の実装レベルの詳細は、API リファレンス を参照してください。

4. GWpy Compatibility and GWexpy Extensions#

  • GWexpy は GWpy の上に構築されており、基本的なデータモデルと操作感を尊重しています。

  • 一方で、Matrix 系コンテナ、フィールド API、追加 I/O、解析ユーティリティなど GWpy にはない拡張があります。

  • 「GWpy と共通の仕様」と「GWexpy 固有の追加要素」を切り分けて確認したい場合は、移行ガイドを参照してください。

移行向けの案内は GWpy ユーザーのための GWexpy と GWpy 差分 API インデックス を参照してください。

5. Where to Go Next#

次に読む#