sgn-gwframe 0.5.0

Gravitational wave frame file I/O elements for sgn-ts

sgn-gwframe

Gravitational wave frame file I/O elements for sgn-ts

---

Resources

• Documentation
• Source Code
• Issue Tracker

Installation

pip install sgn-gwframe

Features

• Read timeseries data from .gwf frame files, frame caches, or lists of frame files
• Watch directories for new frame files in real-time with automatic gap detection
• Write timeseries data to .gwf files with compression, multi-frame support, and retention policies
• Integrates as source and sink elements for SGN pipelines

Quickstart

Read from frame files

from sgn_gwframe import GWFrameSource
from sgn.apps import Pipeline

src = GWFrameSource(
    name="gwosc",
    channels=["L1:GWOSC-16KHZ_R1_STRAIN"],
    frames="frames.cache",
    start=1187008882,
    end=1187008896,
)

pipeline = Pipeline()
pipeline.insert(src, ...)
pipeline.run()

Watch a directory for live frame data

from sgn_gwframe import GWFrameWatchSource
from sgn.apps import Pipeline

src = GWFrameWatchSource(
    name="L1_live",
    channels=["L1:GDS-CALIB_STRAIN"],
    watch_dir="/data/frames/L1",
)

pipeline = Pipeline()
pipeline.insert(src, ...)
pipeline.run()

Write frame files

from sgn_gwframe import GWFrameSink
from sgn.apps import Pipeline

sink = GWFrameSink(
    name="writer",
    channels=["H1:GDS-CALIB_STRAIN"],
    duration=1,
    output_dir="output",
    description="FILTERED",
    max_files=100,
)

pipeline = Pipeline()
pipeline.insert(..., sink)
pipeline.run()