sgnax 0.1.0

Multi-channel auxiliary burst search pipeline - a rewrite of snax using SGN framework

SGNAX

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

Overview

SGNAX performs matched-filter analysis on auxiliary channels to detect burst signals. 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

• Multi-rate sine-Gaussian template bank generation
• Flexible data source support (frames, devshm, arrakis, pre-whitened)
• GPU-accelerated correlation via PyTorch
• Windowed trigger aggregation across rates
• HDF5 output format

Installation

pip install sgnax

For development:

pip install -e ".[dev]"

Usage

Run the extraction pipeline:

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.