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.7.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.7.0-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sgn_gwframe-0.7.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.7.0.tar.gz
Algorithm Hash digest
SHA256 7cd177e58d1f0576139c73ae6101479d2701c72f0adc870c99d2e5049e662e4e
MD5 c0695617ade4405aed3449dd425487bd
BLAKE2b-256 a0f500c7d8543157521dbf4a22f44f920157a5353515c439e46e74c4c3c7a068

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sgn_gwframe-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 22.7 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 51523481f9a1f6012d7076bc5b8c65d926827ee718dd6425353dac9bb92ce58a
MD5 e3ff86602dd189ce82e928fb3bbe4b4e
BLAKE2b-256 d904b6a29dbc4a7a774111c8bd4f93d5199ee940629d5eeee3ce25c1b88606cd

See more details on using hashes here.

Release history Release notifications | RSS feed

0.9.1

2 files

0.9.0

2 files

0.8.0

2 files

This release

0.7.0 This release

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