Getting Started

We provide a systematic learning path for GWexpy users. Choose the best starting point based on your background and goals.

Quick Summary

Item	Details
Page Role	Guide
Target Audience	Experimental data analysts, GWpy users, and anyone interested in signal processing with Python.
Prerequisites	Basics of Python 3.11+, NumPy array manipulation, (Recommended) Matplotlib.
Use Cases	Choose a learning path, find the GWpy migration entry point, or identify the shortest path to a working workflow
Time Required	From 5 minutes (Quick Start) to 30 minutes (Basic Hands-on).
Goal	Load data, visualize results, and perform basic frequency-domain analysis.
Search Keywords	getting started, learning path, GWpy migration, tutorial entry point

If you want the shared assumptions and FFT/time conventions first, use Prerequisites and Conventions as the entry point.

On This Page

• Choose Your Path

• Learning Path

• Next Steps

Choose Your Path

🚀 5-min Quick Start

Quickstart

For those who want to see results immediately. Get a figure in just 3 lines of code.

📖 30-min Hands-on

Tutorial index

Learn the core data structures and GWexpy-specific matrix operations from scratch.

🔄 For GWpy Users

Migration from GWpy

For current GWpy users. Start with the migration recipes, then use the GWpy Difference API Index when you need a difference-oriented lookup of added APIs.

Learning Path

1. Preparation

Start with the Installation Guide to prepare a Python 3.11+ environment.

2. Core Data Structures

We recommend learning the primary containers in the following order:

1. Basic Time Series

2. Basic Frequency Series

3. Basic Spectrograms

4. Plot Customization

3. Advanced Analysis

Refer to these guides based on your needs:

• Multi-channel & Matrix Processing: Using Matrix Containers

• High-dimensional Data: Field API Intro / ScalarField Slicing Guide

• Signal Processing: Fitting / HHT / ARIMA

4. Practical Applications

Explore real-world analysis workflows in our Case Studies Gallery.

Next to Read

• Case Studies Gallery - Visual examples and practical workflows.

• All Tutorials

• Migration from GWpy - start from the difference-oriented migration recipes

• GWpy Difference API Index - look up added APIs from a GWpy-difference view

• Prerequisites and Conventions - entry point for environment assumptions, GPS time, and FFT conventions

• API Reference

• Validated Algorithms - Verification reports for numerical accuracy.