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.Alert.avsc') as f:
...     json.load(f)
...
{'name': 'Alert', 'namespace': 'igwn.alerts', 'type': 'record', 'doc': 'Alert schema.', 'fields': [{'name': 'alert_type', 'type': 'igwn.alerts.AlertType', 'doc': 'The type of alert; the possible values are EARLYWARNING, 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.EventInfo'], 'doc': 'Information about the event, if any.'}, {'name': 'external_coinc', 'type': ['null', 'igwn.alerts.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.'}]}

To contribute

This package uses pre-commit to automate code formatting and validation. Before your first commit, run these commands:

pip install pre-commit
pre-commit install