Skip to main content

A unified collection of SNEWS data, models, and schema

Project description

SNEWS Data Formats

This package contains common data models and utilities for standardizing data formats across SNEWS packages.

Features

  • Data models for key SNEWS data types like messages and timestamps with validation via Pydantic
  • Message models for different tiers like heartbeat, retraction, timing, significance, and coincidence
  • Utilities for handling nanosecond timestamps and leap seconds
  • Static data for supported detectors
  • Generation of JSON schemas for data models
  • Comprehensive testing suite

Getting Started

If you don't have poetry, install that first.

Install the package:

poetry install

Use it in your code:

from snews.models.messages import SignificanceTierMessage

message = SignificanceTierMessage(
    detector_name="Super-K",
    p_values: [0.43, 0.32, 0.01],
    t_bin_width_sec: 5e-3
)

print(message.model_dump())

See the documentation for more details on the available data models and utilities.

See snews/examples for ipython notebooks.

Contributing

Contributions are welcome!

Project details


Download files

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

Source Distribution

snews_data_formats-1.0.0.tar.gz (43.8 kB view details)

Uploaded Source

Built Distribution

snews_data_formats-1.0.0-py3-none-any.whl (39.4 kB view details)

Uploaded Python 3

File details

Details for the file snews_data_formats-1.0.0.tar.gz.

File metadata

  • Download URL: snews_data_formats-1.0.0.tar.gz
  • Upload date:
  • Size: 43.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.3 Darwin/23.5.0

File hashes

Hashes for snews_data_formats-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b4329635b4d9350cc045c324983971a839eeb4828c6e9aaf8ef42bfe8b35c367
MD5 bfa6f2377fdd2e49e870296d4d09fff0
BLAKE2b-256 e5068c2faa53b82cc851844bd1afb521bd03d559395b3c2640db875749deb9b7

See more details on using hashes here.

File details

Details for the file snews_data_formats-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for snews_data_formats-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fcf057cda7ccd3465d80967082484cf490c33e88e39bce80816b67ff56d83bc3
MD5 5ac36f198f8920e576909239d6cb9452
BLAKE2b-256 1ab960f3075007e1c4e1186cbe842745bf4735846261f33f6ad7a674909b7d94

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page