Skip to main content

sgn-gwframe

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

ci coverage documentation pypi version


Resources

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()

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sgn_gwframe-0.9.0.tar.gz (4.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sgn_gwframe-0.9.0-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

Details for the file sgn_gwframe-0.9.0.tar.gz.

File metadata

  • Download URL: sgn_gwframe-0.9.0.tar.gz
  • Upload date:
  • Size: 4.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.13.12 HTTPX/0.28.1

File hashes

Hashes for sgn_gwframe-0.9.0.tar.gz
Algorithm Hash digest
SHA256 1ac19076fc4535f47f71f12b3d2d44e169b6887fe9b023c6f09e9c89a6a7ce67
MD5 70647366bffe86a3ad0ddefab29fa709
BLAKE2b-256 4a32e40e0ad3833899848e4ae8afc8552040f6f665ed12d18aa64218901f8d72

See more details on using hashes here.

File details

Details for the file sgn_gwframe-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: sgn_gwframe-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 27.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.13.12 HTTPX/0.28.1

File hashes

Hashes for sgn_gwframe-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0ab5dd3b1c78ac50af1b3c105d14fcdafd4220bbb11ee4ecd1af30c07e50311
MD5 90d8ae7b0f48e05295da2d3f6cfd0cdf
BLAKE2b-256 59822916c46563be200920e18455a9e8f84517e8607929ef53b0994619f4e065

See more details on using hashes here.

Release history Release notifications | RSS feed

0.9.1

2 files

This release

0.9.0 This release

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page