From 8a69f8dfe66012744a5e6fd275a67a3bce508661 Mon Sep 17 00:00:00 2001 From: Jan David Mol <mol@astron.nl> Date: Wed, 23 Mar 2022 12:29:34 +0100 Subject: [PATCH] Updated statistics writer documentation to use new executable name and explicitly give instructions on how to install our software --- tangostationcontrol/docs/source/devices/sst-xst.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tangostationcontrol/docs/source/devices/sst-xst.rst b/tangostationcontrol/docs/source/devices/sst-xst.rst index cce03f691..b3b0ec460 100644 --- a/tangostationcontrol/docs/source/devices/sst-xst.rst +++ b/tangostationcontrol/docs/source/devices/sst-xst.rst @@ -118,12 +118,12 @@ The easiest way to capture this stream is to use our ``statistics_writer``, whic - stores packet header information per timestamp, as HDF5 attributes, - writes to a new file at a configurable interval. -To run the writer:: +To install the software locally and run the writer:: - cd devices/statistics_writer - python3 statistics_writer.py --mode SST --host localhost + pip install 'tangostationcontrol@git+https://git.astron.nl/lofar2.0/tango.git#subdirectory=tangostationcontrol' + l2ss-statistics-writer --mode SST --host localhost -The correct port will automatically be chosen, depending on the given mode. See also ``statistics_writer.py -h`` for more information. +The correct port will automatically be chosen, depending on the given mode. See also ``l2ss-statistics-writer -h`` for more information. The writer can also parse a statistics stream stored in a file. This allows the stream to be captured and processed independently. Capturing the stream can for example be done using ``netcat``:: -- GitLab