Size: 218
Comment:
|
Size: 3461
Comment:
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
== Introduction == * [[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. == Install == * 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 }}} == Setting in advance == * 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 }}} == Usage of `lvalert_admin` == * 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" }}} == Usage of `lvalert_listen` and `lvalert_send` == * 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} }}} * send the test alert {{{ $ 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 }}} {{{ $ lvalert_listen -s lvalert-playground.cgca.uwm.edu -c my_listen.ini -r listener1 & }}} |
|
Line 2: | Line 97: |
- [[https://lscsoft.docs.ligo.org/lvalert/guide.html|LVAlert Users Guide]] | * [[https://gwdoc.icrr.u-tokyo.ac.jp/cgi-bin/private/DocDB/ShowDocument?docid=11522|Tagoshi-san's note]] |
Line 4: | Line 99: |
- [[https://lscsoft.docs.ligo.org/lvalert/index.html]] | * [[https://git.ligo.org/lscsoft/lvalert| git repository(lvalert)]] |
Line 6: | Line 101: |
- [[https://computing.docs.ligo.org/conda/environments/igwn-py37/]] | * [[https://lscsoft.docs.ligo.org/lvalert/guide.html|LVAlert Users Guide]] * [[https://lscsoft.docs.ligo.org/lvalert/index.html]] * |
Introduction
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.
Install
We can't install lvalert by igwn on conda environment. (see 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
Setting in advance
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
Usage of `lvalert_admin`
- 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"
- This works only a node which you created.
Usage of `lvalert_listen` and `lvalert_send`
- 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}
- send the test alert
$ 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
$ lvalert_listen -s lvalert-playground.cgca.uwm.edu -c my_listen.ini -r listener1 &