Development

For local development there is a poetry environment that will be able to install most of the components, however some of the components assume you also have specific libraries installed on the host machine (you can find these in the Dockerfile). To work around this it is easier to use the Docker image instead for testing.

There are 2 scripts that are currently working, however we are changing from one to the other. The current script is plasma_to_qa.py, however we are changing over to plasma_to_metrics.py. So if you are using the one of the scripts and nothing is coming through, try the other.

The current processor is built based on the plasma processors available here.

Running the script

To run the script run the following command:

Note

You need to update the Kafka host and the MS file location.

BROKER_INSTANCE=broker plasma-processor \
  ska_sdp_qa_metric_generator.plasma_to_metrics.SignalDisplayMetrics \
  --input <ms file>

There are also helper arguments that can be used:

Argument	Description
--use-random-ids	This will generate random IDs instead of trying to read them from the enviroment.
--ignore-config-db	This instructs not to try to read the config DB.
--disable-kafka	This will run the process, but not output to Kafka.
--metrics <all,stats,spectrum,spectograms,phase,amplitude,lag>	This specifies a comma seperated list of metrics to generate, using all will generate everything.

For a list of other commands and options available use --help when running the script.