ska-mid-cbf-signal-verification

Mid CBF Signal Verification is a docker image that generates test reports from visibilities data.

Code repository: ska-mid-cbf-signal-verification

Documentation on the Developer’s portal: ReadTheDocs

Installation

git clone https://gitlab.com/ska-telescope/ska-mid-cbf-signal-verification
cd ska-mid-cbf-signal-verification
git submodule init
git submodule update
make oci-build

Usage

Test data used in unit testing are found in tests/inputs/. To use other test data, set the TEST_INPUTS_DIR variable when using make command.

By default the tests will output to a subdirectory under results/. This can be changed by setting the RESULTS variable when using make command.

BITE Data

To generate a report containing plots of BITE data:

make bite-test

which will create plots and calculated statistics in the results/bite-results/ directory.

Wide Band State Count

To generate a report from collected WB state count vectors:

make wb-state-count-test

TalonDx Status Report

To generate a report of the TalonDx Status signal verification checkpoint data:

make talondx-status-test

Histogram Report

To generate a report of the histogram signal verification checkpoint data:

make histogram-test

Packet Stream Repair Report

To generate a report of the Packet Stream Repair signal verification checkpoint data:

make packet-stream-repair-test

Visibilities Report

To generate a report of the Visibilities signal verification checkpoint data:

make visibilities-test

Slim Links Report

To generate a report of the Slim Links signal verification checkpoint data:

make slim-links-test

Using Jupyter Notebook

To start the Jupyter notebook in the docker container:

make notebook-docker

then you can connect to it at host:8888. The port is configurable in the Makefile by setting NOTEBOOK_PORT.

To start the Jupyter notebook locally (requires Jupyter package to be installed in the local environment):

make notebook-local

then you can connect to it at localhost:8888.

To see the available options:

make help

Data Collector

The data collector is a separate docker image. It gathers data files that can be used by Signal Verification to generate various reports.

To collect the data, a few variables can be set to overide the default values in the Makefile.

TANGO_HOST=<tango DB host:port>
OUTPUT_DIR=<output directory>
WB_STATE_COUNT_DEVICE=<wb state count device>
TALONDX_STATUS_DEVICE=<talondx status device>
PACKET_STREAM_REPAIR_DEVICE_STRING=<packet stream repair list of devices>

To collect WB State Count vectors:

make collect-wb-state-count

To collect TalonDx Status checkpoint data:

make collect-talondx-status

To collect Packet Stream Repair checkpoint data:

make collect-packet-stream-repair