Diff for "KAGRA/Subgroups/DET/LVAlert"

Differences between revisions 12 and 48 (spanning 36 versions)

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)

-  ⇤ ← Revision 12 as of 2021-04-05 20:45:01 → 
  Size: 756
  Editor: HirotakaYuzurihara
  Comment:
+   ← Revision 48 as of 2021-11-19 04:47:39 → ⇥
  Size: 2414
  Editor: HirotakaYuzurihara
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
+== Introduction ==
 * 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 2:
+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 9:
+Line 14:
-== Links ==
 * [[https://gwdoc.icrr.u-tokyo.ac.jp/cgi-bin/private/DocDB/ShowDocument?docid=11522|Tagoshi-san's note]]
+ * 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 12:
+Line 19:
- * [[https://git.ligo.org/lscsoft/lvalert| git repository(lvalert)]]
+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
-Line 14:
+Line 28:
- * [[https://lscsoft.docs.ligo.org/lvalert/guide.html|LVAlert Users Guide]]
+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 16:
+Line 42:
- * [[https://lscsoft.docs.ligo.org/lvalert/index.html]]
-Line 18:
+Line 43:
- *
+== Setting in advance ==
 


== Usage of lvalert_admin ==


== Usage of lvalert_listen and lvalert_send ==



== Related 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]]