Differences between revisions 18 and 50 (spanning 32 versions)
⇤ ← Revision 18 as of 2021-04-05 20:57:17 →
Size: 1195
Editor: HirotakaYuzurihara
Comment:
← Revision 50 as of 2021-11-19 04:59:53 → ⇥
Size: 2333
Editor: HirotakaYuzurihara
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
 * [[https://git.ligo.org/lscsoft/lvalert/-/tree/master|LValert]] is The LIGO-Virgo Alert System (LVAlert)
  * a prototype notification service built on the xmpp (jabber) protocol and the pubsub extension.
  * It provides a basic notification tool which allows multiple producers and consumers of notifications.		  * The LIGO-Virgo Alert System (LVAlert) [[https://git.ligo.org/lscsoft/igwn-alert|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.

== Links ==

 * [[https://git.ligo.org/lscsoft/igwn-alert|git repo, igwn-alert]]
 * [[https://lscsoft.docs.ligo.org/igwn-alert/|igwn-alert document]]
 * [[https://git.ligo.org/lscsoft/igwn-alert|git repo, igwn-alert]]
 * [[KAGRA/Subgroups/DET/LVAlert_python2 |LVAlert instruction for python2]]

 * [[https://gracedb.ligo.org/documentation/responding_to_lvalert.html|Tutorial GraceDB]]
Line 7: Line 18:
 * We can't install lvalert by [[https://computing.docs.ligo.org/conda/environments/igwn-py37/|igwn]] on conda environment. (see [[https://git.ligo.org/lscsoft/lvalert/-/issues/19|lvalert_admin broken on both conda igwn-py2 and igwn-py37 environments]])
  * because lvalert depends on legacy package (`pyxmpp`)
 * To install lvalert on python2,		  * The latest version is 0.1.1 (2021/11/19)
Line 11: Line 20:
sudo apt install python-ligo-lvalert pip install igwn-alert
Line 14: Line 23:
== Setting in advance ==  * 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} ...
Line 16: Line 28:
* visit [[https://lvalert-test.cgca.uwm.edu]] and activate your account. 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)
}}}
Line 19: Line 52:
== Links ==
 * [[https://gwdoc.icrr.u-tokyo.ac.jp/cgi-bin/private/DocDB/ShowDocument?docid=11522|Tagoshi-san's note]]		 == Setting in advance ==
 
Line 22: Line 55:
 * [[https://git.ligo.org/lscsoft/lvalert| git repository(lvalert)]]
Line 24: Line 56:
 * [[https://lscsoft.docs.ligo.org/lvalert/guide.html|LVAlert Users Guide]] == Usage
Line 26: Line 58:
 * [[https://lscsoft.docs.ligo.org/lvalert/index.html]]

 *

Introduction

  • The 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.

Install

  • The latest version is 0.1.1 (2021/11/19) 
    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

== Usage

KAGRA/Subgroups/DET/LVAlert (last edited 2022-05-26 18:05:01 by HirotakaYuzurihara)