Skip to content

Caratekit test instructions

Jump to bottom
Gyula Jozsa (Josh) edited this page Apr 27, 2020 · 3 revisions

General usage

Caratekit is currently located at https://github.com/ska-sa/caracal/blob/master/caratekit.sh. It is a bash script.

Full documentation: $ caratekit.sh -v or $ caratekit.sh -h

Testing your caracal with caratekit

Define

  • ${workspace} a parent directory to all tests
  • ${caracal} the location of the local caracal
  • ${testname} a name for your test (will create a directory ${testname} in ${workspace}
  • ${testdata_short} the location of the test data for the short test
  • ${testdata_long} the location of the test data for the long test

${testdata_short} should only contain the measurement set 1532022061_subset.ms ${testdata_long} should only contain the measurement sets 1524929477.ms 1524947605.ms 1532022061.ms

  • Singularity-short test: caratekit.sh -ws ${workspace} -td ${testdata_short} -lc ${caracal} -ct ${testname} -sm -or -f
  • Singularity-long test:caratekit.sh -ws ${workspace} -td ${testdata_long} -lc ${caracal} -ct ${testname} -sa -or -f
  • Docker-short test: caratekit.sh -ws ${workspace} -td ${testdata_short} -lc ${caracal} -ct ${testname} -dm -or -f
  • Docker-long test:caratekit.sh -ws ${workspace} -td ${testdata_long} -lc ${caracal} -ct ${testname} -da -or -f

The long test uses the config file carateConfig.yml in sample_configurations, the short test uses the config file minimalConfig.yml in sample_configurations.

More use cases

https://github.com/ska-sa/caracal/issues/859

How to use caratekit to reduce data

https://caracal.readthedocs.io/en/latest/manual/caratekit_utility/index.html

Clone this wiki locally