Skip to main content

JSON and Avro Schema for gravitational-wave alerts

Project description

igwn-gwalert-schema

JSON and Avro Schema for gravitational-wave alerts.

To install

$ pip install igwn-gwalert-schema

To use

$ python
>>> from importlib import resources
>>> import json
>>> with resources.open_text('igwn_gwalert_schema', 'igwn.alerts.v1_0.Alert.avsc') as f:
...     json.load(f)
... 
{'name': 'Alert', 'namespace': 'igwn.alerts.v1_0', 'type': 'record', 'doc': 'Alert schema v1.0.', 'fields': [{'name': 'alert_type', 'type': 'igwn.alerts.v1_0.AlertType', 'doc': 'The type of alert; the possible values are EARLY_WARNING, PRELIMINARY, INITIAL, UPDATE, RETRACTION.'}, {'name': 'time_created', 'type': 'string', 'doc': 'The time this notice was created in ISO 8601 format.'}, {'name': 'superevent_id', 'type': 'string', 'doc': 'The GraceDB superevent ID.'}, {'name': 'event', 'type': ['null', 'igwn.alerts.v1_0.EventInfo'], 'doc': 'Information about the event, if any.'}, {'name': 'external_coinc', 'type': ['null', 'igwn.alerts.v1_0.ExternalCoincInfo'], 'doc': 'Information about the coincidence with an non-GW event, if any.'}, {'name': 'urls', 'type': {'type': 'map', 'values': 'string', 'default': {}}, 'doc': 'URLs relevant to the event, if any.'}]}

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

igwn-gwalert-schema-1.0.0.tar.gz (16.1 kB view details)

Uploaded Source

Built Distribution

igwn_gwalert_schema-1.0.0-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file igwn-gwalert-schema-1.0.0.tar.gz.

File metadata

  • Download URL: igwn-gwalert-schema-1.0.0.tar.gz
  • Upload date:
  • Size: 16.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for igwn-gwalert-schema-1.0.0.tar.gz
Algorithm Hash digest
SHA256 28dcd14d263df65cfceef85aa8b28c344a2d465e8f4fa4016675992f6817fc1d
MD5 c0bca557b01a3a1bf9665ce0faa3cde4
BLAKE2b-256 c0769eab85fde60d0ef5b061fa8790e708e0d87442751ac61b71bdd8f8926413

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for igwn_gwalert_schema-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 18fae274d72687376b7376189d6602ac157d24f3a487e18d195ab7788153e7b6
MD5 cea1964f2fd13ebe325afbf008f81402
BLAKE2b-256 c513fe9154af79623c61133ef08b478adbd45335ce003da60850d6673a3ce70f

See more details on using hashes here.

Provenance

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