index.rst 893 Bytes
Newer Older
Leo Pound Singer's avatar
Leo Pound Singer committed
1
sleek-lvalert Documentation
Leo Pound Singer's avatar
Leo Pound Singer committed
2
===========================
Leo Pound Singer's avatar
Leo Pound Singer committed
3 4

sleek-lvalert is a client for the LIGO/Virgo LVAlert pubsub infrastructure that
5
is powered by :doc:`slixmpp <slixmpp:index>`. It requires Python 3.5 or later.
Leo Pound Singer's avatar
Leo Pound Singer committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40

Quick Start
-----------

Install with pip_::

    pip install sleek-lvalert

Put your username and password in your netrc_ file in ``~/.netrc``::

    echo 'machine lvalert-test.cgca.uwm.edu login albert.einstein password gravity' >> ~/.netrc
    chmod 0600 ~/.netrc

Subscribe to some nodes::

    lvalert subscribe cbc_gstlal cbc_pycbc cbc_mbtaonline

Listen for LVAlert messages::

    lvalert listen

API
---

.. automodule:: sleek_lvalert

Command Line Interface
----------------------

.. argparse::
    :module: sleek_lvalert.tool
    :func: parser

.. _netrc: https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html
.. _pip: http://pip.pypa.io