Tutorials (Feature-Oriented Learning)

Note

Page role: Guide index

Learn how to use GWexpy through feature-oriented, interactive examples.

Audience: New users, GWpy users, and analysis practitioners who want step-by-step notebook-based learning. Prerequisites: A working GWexpy environment and familiarity with the basics in Getting Started. Use this page for: Choosing feature-oriented tutorials by data structure, workflow, and expected difficulty. Search hints: notebooks, Jupyter, tutorial index, beginner workflow, Field API, signal processing, interoperability

Tip

If you’re new to GWexpy, we recommend starting with Getting Started.

These tutorials are generated from Jupyter Notebook source files. To run them locally, download the corresponding .ipynb from docs/web/en/user_guide/tutorials/ in the repository.

Note

On this page: Start with sections I-II for fundamentals, jump to III for Field API notebooks, use IV-VI for workflow-oriented analysis, and use VII for table-based segment analysis.

Note

Naming convention: tutorial titles follow the form “Feature: Task”. English pages keep titles English-only, except for API identifiers and library names.

Note

Each tutorial shows its difficulty, estimated time, and primary audience. Audience labels are normalized to Beginners, GWpy Users, and Analysis Practitioners.

Note

Tutorials are feature-oriented examples that teach one class, container, or capability at a time. Goal-oriented demonstrations that combine multiple features are collected in Case Studies (Goal-Oriented Workflows) under Case Studies.

Note

Reference bridge: When you finish a tutorial and need exact classes, methods, or conventions, move to Reference, then continue into API Reference or Reference Topics.

I. Core Data Structures

Fundamental data containers and basic operations.

TimeSeries: Basics Beginner 15 min Beginners
FrequencySeries: Basics Beginner 15 min Beginners
Spectrogram: Basics Beginner 15 min Beginners
Noise Generation: Basics Beginner 15 min Beginners
Plotting: Basics Beginner 15 min Beginners
Map Plotting: Basics Beginner 20 min GWpy Users
Histogram: Basics Beginner 15 min Beginners

II. Multi-channel & Matrix Containers

Handling multiple channels efficiently using Matrix classes.

TimeSeriesMatrix: Matrix Basics Beginner 20 min GWpy Users
FrequencySeriesMatrix: Matrix Basics Beginner 20 min GWpy Users
SpectrogramMatrix: Matrix Basics Beginner 20 min GWpy Users

III. High-dimensional Fields

Next-generation API for scalar, vector, and tensor fields in 4D spacetime.

Field API: ScalarField Basics Intermediate 30 min Analysis Practitioners
Field API: VectorField Basics Intermediate 30 min Analysis Practitioners
Field API: TensorField Basics Intermediate 30 min Analysis Practitioners
Field API: ScalarField Signal Processing Intermediate 45 min Analysis Practitioners
Field API: Advanced Analysis Workflow Intermediate 45 min Analysis Practitioners
Field API: Advanced Analysis Integration Intermediate 45 min Analysis Practitioners

IV. Advanced Signal Processing

Statistical analysis and advanced transforms.

Fitting: Basics Beginner 20 min GWpy Users
Fitting: Spectral Line Analysis Intermediate 30 min Analysis Practitioners
Spectrogram: Normalization and Cleaning Intermediate 45 min Analysis Practitioners
Peak Detection: Basics Intermediate 30 min Analysis Practitioners
Peak Tracking: Time Evolution Intermediate 30 min Analysis Practitioners
HHT: Analysis Advanced 45 min Analysis Practitioners
Time-Frequency Analysis: Interactive Comparison Intermediate 30 min Analysis Practitioners
Time-Frequency Analysis: Method Selection Guide Intermediate 45 min Analysis Practitioners
Control Analysis: Discretization Basics Intermediate 30 min Analysis Practitioners
Control Analysis: Resonance and Feedback Basics Intermediate 30 min Analysis Practitioners
Control Analysis: Plant Modeling from Measured Response Intermediate 30 min Analysis Practitioners
ARIMA: Time Series Forecasting Advanced 45 min Analysis Practitioners
Correlation Analysis: Statistical Methods Intermediate 30 min Analysis Practitioners
ML Preprocessing: Individual Methods Intermediate 30 min Analysis Practitioners
Linear Algebra: Gravitational Wave Analysis Intermediate 30 min Analysis Practitioners
Non-Gaussian Noise Analysis: Rayleigh and Gaussian-Chi Intermediate 30 min Analysis Practitioners
Coupling Analysis: Multi-Channel Coupling Advanced 45 min Analysis Practitioners
Decomposition Analysis: PCA, ICA, and Eigenmodes Advanced 45 min Analysis Practitioners

V. Data I/O & Interoperability

Tutorials for file ingest, read/write workflows, and conversions with external libraries.

Interoperability: Basics Beginner 20 min GWpy Users

VI. Noise Hunting & Specialized Tools

Tools for specific noise hunting and diagnostics tasks.

Bruco: Basics Advanced 45 min Analysis Practitioners

VII. Segment Analysis

Table-based analysis for time segments.

SegmentTable: Basics Beginner 15 min Beginners
Segment Analysis: Basic Pipeline Beginner 20 min GWpy Users
ASD Analysis: Pipeline Intermediate 30 min Analysis Practitioners
Segment Analysis: Visualization Intermediate 30 min Analysis Practitioners

Note

Goal-oriented demonstrations live in Case Studies (Goal-Oriented Workflows). See the case studies section for workflows such as noise budgeting, transfer function measurement, ML preprocessing, and event-synchronized analysis. For next steps after this page, see ML Preprocessing Pipeline and Bootstrap PSD and GLS Fitting there.