Introduction

• LIGO-Virgo Alert System (LVAlert) igwn-alert

  • The International Gravitational Wave Network Alert System (igwn-alert) is a notification service built on the Apache Kafka protocol and the pubsub extension.
  • It is a higher-level modification of SCIMMA's hop-client to streamline receiving and responding to alerts from GraceDB.
  • This package replaces the legacy LIGO LVAlert XMPP-based alert system.
  • The API are compatible with Python 3
• Retirement of existing LVAlert service targeted for ~April 2022.
  • In O4, we will use igwn-alert.

Install

• The latest version is 0.1.1 (2021/11/19)
  • Available in pip and conda shortly.

  pip install igwn-alert

• help

  % igwn-alert -h
  usage: igwn-alert [-h] [-g GROUP] [-l {critical,error,warning,info,debug}] [-n NETRC] [-s SERVER] [-u USERNAME] {listen,subscriptions,topics,unsubscribe,send} ...
  
  positional arguments:
    {listen,subscriptions,topics,unsubscribe,send}
                          sub-command help
      listen              Listen for igwn-alert messages and print them to stdout.
      subscriptions       List your subscriptions
      topics              List available pubsub topics
      unsubscribe         Unsubscribe from one or more topics
      send                publish contents of a file to a pubsub topic
  
  optional arguments:
    -h, --help            show this help message and exit
    -g GROUP, --group GROUP
                          GraceDB group name (e.g., gracedb, gracedb-playground)
    -l {critical,error,warning,info,debug}, --log {critical,error,warning,info,debug}
                          Log level
    -n NETRC, --netrc NETRC
                          netrc file (default: read from NETRC environment variable or ~/.netrc)
    -s SERVER, --server SERVER
                          igwn-alert server hostname
    -u USERNAME, --username USERNAME
                          User name (default: look up in auth.toml or .netrc)

Setting in advance

• The authentification between the client and the server is managed by SciMMA.

• The first step is to make a SCiMMa account by visiting https://my.hop.scimma.org/.

  • At this time, access to igwn-alert is limited to LIGO, Virgo, or KAGRA members.

Usage

Links

• git repo, igwn-alert

• igwn-alert, documentation outlining API

• igwn-alert, user guide for how to get started

• LVAlert instruction for python2 (out of date)

• Tutorial GraceDB