sgnax 0.1.1

Multi-channel excess-power search pipeline - a rewrite of snax using SGN framework

SGNAX

SGNAX is a multi-channel excess-power search pipeline - a rewrite of SNAX using the SGN framework for LIGO gravitational wave detection.

Overview

SGNAX detects short-duration transients in detector channels — strain and auxiliary alike — with two searches: a Q-transform excess-power search (sgnax-qtransform) and a matched-filter search against a sine-Gaussian template bank (sgnax-extract). It is built on the SGN (Stream Graph Navigator) family of libraries:

• sgn: Base streaming graph framework
• sgn-ts: TimeSeries utilities
• sgn-ligo: LIGO-specific extensions

Features

• Q-transform excess-power search over a (frequency, Q) tile grid, with time-based trigger clustering
• Matched-filter search with multi-rate sine-Gaussian template banks and GPU-accelerated PyTorch correlation
• Flexible data source support (frames, devshm, arrakis), each whitened in-pipeline
• HDF5 output format, identical from both searches

Installation

pip install sgnax

For development:

pip install -e ".[dev]"

Usage

Run the Q-transform search:

sgnax-qtransform --help

or the matched-filter search:

sgnax-extract --help

Development

Run the full test suite:

make all

Individual commands:

make test        # Run tests
make lint        # Run linter
make format      # Format code
make type-check  # Run type checker
make docs        # Build documentation

License

GPL-3.0-or-later. See the LICENSE file for details.