gwcelery.tasks.gcn module

Subsystem for sending, receiving, and processing Gamma-ray Coordinates Network [GCN] notices.

References

[GCN]

https://gcn.gsfc.nasa.gov

(task)gwcelery.tasks.gcn.broker

Run an embedded Comet VOEvent broker to send GCNs.

(task)gwcelery.tasks.gcn.send(message)

Send a VOEvent to the local Comet instance for forwarding to GCN.

Internally, this just calls comet-sendvo.

gwcelery.tasks.gcn.handler = {<sphinx.ext.autodoc.importer._MockObject object>: [<@task: gwcelery.tasks.external_triggers.handle_sn_gcn of gwcelery>, <@task: gwcelery.tasks.external_triggers.handle_grb_gcn of gwcelery>, <@task: gwcelery.tasks.external_triggers.handle_grb_gcn of gwcelery>, <@task: gwcelery.tasks.external_triggers.handle_grb_gcn of gwcelery>, <@task: gwcelery.tasks.external_triggers.handle_grb_gcn of gwcelery>, <@task: gwcelery.tasks.external_triggers.handle_grb_gcn of gwcelery>, <@task: gwcelery.tasks.external_triggers.handle_grb_gcn of gwcelery>, <@task: gwcelery.tasks.gcn.validate.validate_voevent of gwcelery>, <@task: gwcelery.tasks.gcn.validate.validate_voevent of gwcelery>, <@task: gwcelery.tasks.gcn.validate.validate_voevent of gwcelery>]}

Function decorator to register a handler callback for specified GCN notice types. The decorated function is turned into a Celery task, which will be automatically called whenever a matching GCN notice is received.

Parameters:

• *keys – List of GCN notice types to accept
• **kwargs – Additional keyword arguments for celery.Celery.task().

Examples

Declare a new handler like this:

@gcn.handler(gcn.NoticeType.FERMI_GBM_GND_POS,
             gcn.NoticeType.FERMI_GBM_FIN_POS)
def handle_fermi(payload):
    root = lxml.etree.fromstring(payload)
    # do work here...

(task)gwcelery.tasks.gcn.listen

Listen to GCN notices forever. GCN notices are dispatched asynchronously to tasks that have been registered with gwcelery.tasks.gcn.handler().