Giter Club home page Giter Club logo

snews-data-formats's Introduction

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!

snews-data-formats's People

Contributors

justinvasel avatar

Watchers

Chris Tunnell avatar  avatar Andrey Sheshukov avatar Segev BenZvi avatar Kate Scholberg avatar J Tseng avatar Alec Habig avatar

snews-data-formats's Issues

Populate detector data

As of opening this issue, snews/data/detectors only has one detector entry (super-k.json). We want one for each SNEWS detector.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.