Differences between revisions 35 and 45 (spanning 10 versions)
Revision 35 as of 2021-04-05 22:45:15
Size: 3905
Comment:
Revision 45 as of 2021-11-19 04:44:33
Size: 1149
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.
Line 7: Line 9:
 * 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,
 {{{
sudo apt install python-ligo-lvalert
 }}}
 * The latest version is 0.1.1 (2021/11/19)
{{{
pip install igwn-alert
}}}
Line 16: Line 16:
 * see [[https://gracedb.ligo.org/documentation/responding_to_lvalert.html|this document]]
Line 18: Line 17:
 * visit [[https://lvalert-test.cgca.uwm.edu]] and activate your account.

 * prepare `$HOME/.netrc`
  * albert.einstein should be your KAGRA account.
  * `PASSWORD` should be the password you set at Account Activation site.

 {{{
$ echo 'machine lvalert.cgca.uwm.edu login albert.einstein password PASSWORD' >> ~/.netrc
$ echo 'machine lvalert-playground.cgca.uwm.edu login albert.einstein password PASSWORD' >> ~/.netrc
$ echo 'machine lvalert-test.cgca.uwm.edu login albert.einstein password PASSWORD' >> ~/.netrc
$ chmod 0600 ~/.netrc
 }}}
Line 33: Line 20:
 * get a list of existing nodes
 {{{
$ lvalert_admin -s lvalert-playground.cgca.uwm.edu --get-nodes
 }}}

 * create a test node
 {{{
$ lvalert_admin -s lvalert-playground.cgca.uwm.edu --create --node test_k1det
Creating node test_k1det
Successfully completed operation
 }}}

 * subscribe a node
 {{{
$ lvalert_admin -s lvalert-playground.cgca.uwm.edu --subscribe --node test_k1det
Successfully subscribed to node test_k1det
 }}}

 * remove a note
 {{{
$ lvalert_admin -s lvalert-playground.cgca.uwm.edu --delete --node test_k1det
 }}}

 * check current subscriptions
 {{{
$ lvalert_admin -s lvalert-playground.cgca.uwm.edu --subscriptions
 }}}

 * unsubscribe
  * This works only a node which you created.

  {{{
$ lvalert_admin --username hirotaka.yuzurihara -s lvalert-playground.cgca.uwm.edu --node "tagoshi-testnode"
  }}}
Line 70: Line 23:
 * launch the lvalert_listern
  * this should run in the background
 {{{
% lvalert_listen -s lvalert-playground.cgca.uwm.edu -c my_listen.ini -r listener1 &
 }}}

 * prepare the dummy alert
  * the real alert will be sent as JSON format. (But, I don't know the actual keys.)
 {{{
$ cat test1.txt
{"uid": "G12345", "alert_type": "new", "far": 1e-8, "gps_time": 1301640384}

$ cat test2.txt
{"uid": "G12345", "alert_type": "new", "far": 1e-8}
 }}}

 * prepare configuration file
  * when we got the alert, the following shell script will run. (Note that this shell script can't use option.)
  * you can see the details of shell script at `/users/yuzu/work/lvalert` in the Kamioka workstation.
 
 {{{
$ cat my_listen.ini
[test_k1det]
executable = ./run_test_k1det.sh
}}}

 * send the test alert
  * Although test1.txt has gps_time, test2.txt has no gps_time.
 {{{
$ lvalert_send --username hirotaka.yuzurihara -s lvalert-playground.cgca.uwm.edu -n test_k1det --file test1.txt

$ lvalert_send --username hirotaka.yuzurihara -s lvalert-playground.cgca.uwm.edu -n test_k1det --file test2.txt
 }}}

 
Line 109: Line 27:
 * [[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]]
Line 110: Line 33:

 * [[https://git.ligo.org/lscsoft/lvalert| git repository(lvalert)]]

 * [[https://gwdoc.icrr.u-tokyo.ac.jp/cgi-bin/private/DocDB/ShowDocument?docid=11522|Tagoshi-san's note]]

 * [[https://lscsoft.docs.ligo.org/lvalert/index.html|document of lvalert (not completed)]]

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

Setting in advance

Usage of lvalert_admin

Usage of lvalert_listen and lvalert_send

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