gkligo 0.2.4

GW (LIGO) utilities

gkligo

Code to download GW Alert skymaps from Kafka, and optionally write them out and/or convert them to MOC files at specified contours.

The code is based on code written by Roy Williams and Leo Singer.

It requires the following python packages:

• gcn-kafka
• healpy
• gkutils
• docopt
• pyYAML
• numpy
• ligo.skymap (via conda install)
• astropy
• mocpy

The command line utilities are:

• downloadGWAlert (Download the alert from Kafka)

The config_example.yaml file is an example config file. Copy it and rename to config.yaml. Get your credentials by following the first part of the Kafka Notices via GCN tutorial. Leave the topics configuration unchanged.

The code has been daemonised so one of the parameters will be start|restart|stop.

Also included is a script called generateGWReports. This will generate coverage reports (CSV files) from the three database (ATLAS, all sky Pan-STARRS, O4 follwup Pan-STARRS).

TO DO:

• Modify generateGWReports to load the GW meta into the database for convenience.