クイックスタート (Quickstart)

GWexpy を使って、最初の解析図を最短で作成しましょう。

このページでわかること

項目

内容

ページ種別

ガイド

対象読者

まず 1 枚プロットを出したい初回利用者、GWpy 互換の入口を見たい利用者

前提

Python 3.11 以上、基本的な pip 操作、NumPy 配列の基礎

こんなときに読む

まず import が通るか確認したい、3 行の最小例を見たい、次に何を読むか決めたい

検索キーワード

quickstart, 最初のプロット, TimeSeries, CSD, 最小例

このページの近道

  • クイックインストール

  • 3行で最初の図を出す

  • 30分で学べるハンズオン

  • 複数チャンネルの解析例

  • 次のステップ

クイックインストール (Quick Install)

GWexpy は現在開発版で、PyPI / Conda にはまだ公開されていないため、まずは GitHub のソースリポジトリから直接インストールしてください：

  • 目的: 開発版を最短でインストールする

  • 入力: Python 3.11 以上と pip

  • 出力: 最初のサンプルを実行できる GWexpy 環境

pip install git+https://github.com/tatsuki-washimi/gwexpy.git

Conda 管理の環境で始めたい場合、NDS2 / FrameLIB などの GW 系バイナリ依存が必要な場合、pygmt などの追加ツールを使いたい場合は、後から場当たり的に足さず インストールガイド の Conda 前提手順から始めてください。

3行で最初の図を出す (3-line Quickstart)

GWexpy の TimeSeries は NumPy 配列から直接作成でき、標準的なプロット機能を備えています。

  • 目的: ランダムな時系列から最初のプロットを 1 枚表示する

  • 入力: 4096 サンプルの NumPy 配列、サンプルレート 4096 Hz、開始時刻 t0=0

  • 出力: TimeSeries オブジェクトと描画ウィンドウ

import numpy as np
from gwexpy.timeseries import TimeSeries

ts = TimeSeries(np.random.randn(4096), sample_rate=4096.0, t0=0)
ts.plot().show()

30分で学べるハンズオン (Interactive Tutorial)

より実践的なワークフローを学びたい場合は、以下のチュートリアルを推奨します。Google Colab ですぐに実行可能です。

🧪 GWexpy 基本ハンズオン

チュートリアル一覧を見る

データの読み込みから、周波数解析（ASD/CSD）、最新のフィールド API による行列操作までを一通り体験します。

Open In Colab

主要概念 (Core Concepts)

GWexpy を使いこなすための 2 つの重要な柱です。

  • TimeSeries / FrequencySeries: 単一チャンネルのデータを扱う基本クラスです。GWpy と高い互換性があり、既存のコードをそのまま動かすことができます。

  • TimeSeriesMatrix / ScalarField: 複数チャンネル（行列形式）や多次元のフィールド系データを扱うための新しい API です。100 チャンネルを超えるような大規模な解析も、1 行のコードで安全に処理できます。

複数チャンネルの解析例

複数チャンネル間のクロススペクトル密度（CSD）を計算する最小例です。

  • 目的: 2 チャンネルの TimeSeries からクロススペクトル密度を計算する

  • 入力: 2 チャンネルの TimeSeriesDict と fftlength=1

  • 出力: csd オブジェクトと CSD プロット

import numpy as np
from gwexpy.timeseries import TimeSeries, TimeSeriesDict

# データの作成
tsd = TimeSeriesDict({
    "H1:STRAIN": TimeSeries(np.random.randn(4096 * 4), sample_rate=4096, t0=0),
    "L1:STRAIN": TimeSeries(np.random.randn(4096 * 4), sample_rate=4096, t0=0),
})

# 2 チャンネル間のクロススペクトル密度 (CSD) を計算
csd = tsd["H1:STRAIN"].csd(tsd["L1:STRAIN"], fftlength=1)
csd.plot().show()

ここでは TimeSeriesDict から対象の 2 チャンネルを取り出し、チャンネル間のクロススペクトル密度を csd として得ています。

困ったときは

実行時にエラーが発生したり、プロットが表示されない場合は、トラブルシューティング を確認してください。原因が環境構築にある場合は、インストールガイド の Conda 前提手順に戻るのが最短です。

次に読む