GWexpy Documentation

GWexpy extends GWpy with additional containers and analysis utilities for time and frequency series data analysis.

Key Features:

• Matrix containers: Efficient multi-channel TimeSeries/FrequencySeries processing

• Field API: 4D spacetime fields (ScalarField, VectorField, TensorField) with time↔frequency and real↔k-space FFT

• Enhanced signal processing: Advanced fitting, HHT, ARIMA, correlation methods

• Numerical stability: Validated algorithms with comprehensive testing

• ML/DL integration: PyTorch, TensorFlow, and scikit-learn interoperability

Quick Start

Start with Installation to set up your environment, then proceed to Quick Start to learn the basics.

Choose Your Guide

For Beginners

Learn from the basics

• Installation Guide

• Quick Start

• Basic Tutorials

Getting Started

For Experimental Data Analysts

Learn from case studies

• Basic usage examples

• Advanced signal processing

• Real-world case studies

Case Studies

For GWpy Users

Migration & Upgrades

• Differences from GWpy

• New Feature Highlights

• Compatibility Information

Getting Started

Visual Examples

Time series visualization example with GWexpy

Example Gallery

Representative case studies:

Noise Budget Analysis

Multi-channel correlation and noise source identification

Case Studies

Transfer Function Measurement

Bode plot and model fitting

Case Studies

Active Damping Control

6-DOF MIMO control simulation

Case Studies

Learning Path by User Level

User Level	Start Here	Next Steps
Beginners	Installation, Quick Start	Getting Started, Tutorials
Researchers	Case Studies	Advanced Signal Processing, API Reference
GWpy Users	Migration Guide	New Feature Tutorials

Main Documentation

User Guide

• Installation
  • Basic install
  • Development install
  • Optional extras
  • Next Steps
• Quickstart
  • Migration from GWpy
  • Generate and Plot Multi-channel Time Series
  • Batch CSD Conversion: Time Series to Frequency Matrix
• Getting Started
  • Quick Example
  • Prerequisites
  • Learning Path
  • Next Steps
• File I/O Supported Formats Guide
  • Supported Formats Overview
  • Format Details
  • Design-Level Support (No Dedicated Implementation in gwexpy)
  • Unimplemented (Stub) Formats
  • Basic Usage of .read() / .write()
  • Reference: Source Implementation Files

Tutorials

• Tutorials
  • I. Core Data Structures
  • II. Multi-channel & Matrix Containers
  • III. High-dimensional Fields
  • IV. Advanced Signal Processing
  • V. Specialized Tools
  • VI. Segment Analysis

Case Studies

• Case Studies
  • Noise Budgeting and Multi-Channel Correlation Analysis
  • Tutorial: Transfer Function Measurement
  • Active Damping for 6-DOF Active Vibration Isolation System (Non-Collocated Configuration)
  • Case Study: Event Synchronized Analysis

Advanced Guides

• Migrating to GWexpy v0.1.1
• GWexpy Features (For GWpy Users)
• Numerical Stability and Precision
• ScalarField Slicing Guide
• Validated Algorithms
• Assumptions and Conventions
• Architecture & Physics

Reference

• Reference
  • API Reference
  • Class Index

Next Steps

To continue learning:

• Getting Started - Detailed learning path

• Tutorials - All tutorials

• Case Studies - Real-world case studies

• API Reference - Class and function details

Advanced Topics:

• ScalarField Slicing - Multi-dimensional data manipulation

• Numerical Stability & Accuracy - Computational reliability

• Validated Algorithms - Algorithm verification reports

Language

• 日本語 (Japanese)