lsst.alert.packet

Contributing

lsst.alert.packet is developed at https://github.com/lsst/alert_packet. You can find Jira issues for this module under the alert_packet component.

Python API reference

lsst.alert.packet Package

Functions

get_latest_schema_version() Get the latest schema version.
get_path_to_latest_schema() Get the path to the primary schema file for the latest schema.
get_schema_path(major, minor) Get the path to a package resource directory housing alert schema definitions.
get_schema_root() Return the root of the directory within which schemas are stored.
load_stamp(file_path) Load a cutout postage stamp file to include in alert.
retrieve_alerts(fp[, reader_schema]) Read alert packets from the given I/O stream.
simulate_alert(schema[, keepNull, arrayCount]) Parse the schema and generate a compliant alert with random contents.

Classes

Schema(schema_definition) An Avro schema.
SchemaRegistry() A registry for alert schemas.