diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6b938f1ac96114baf356b75f1466f859978d2638 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Odissee Docker + +Docker container recipe to run ska-sdp-low-selfcal (https://gitlab.com/ska-telescope/sdp/science-pipeline-workflows/ska-sdp-wflow-selfcal) + + +# Building + +To build the image execute: + +``` + docker build -t [tagname] . +``` + +*Note*: the code is installed and compiled for the specific architecture of the machine that built the docker image. Therefore it might not run on different architectures. + +# Executing the pipeline + +Start the docker container with the command + +``` +docker --rm -it -u $UID:$GID [tagname] [-v /data/volume:/data/volume] /bin/bash + +# within the interactive shell in the container +source /spack/share/spack/setup-env.sh &&\ + spack env activate base + +export EVERYBEAM_DATADIR=$(find /spack/opt/spack -name "everybeam-0.7.0*")/share/everybeam +``` + +And finally to run the pipeline use the following command: + +``` +export DP3=$(which DP3) +export WSCLEAN=$(which wsclean) + + +python /ska-sdp-wflow-selfcal/src/ska_sdp_wflow_selfcal/pipeline/main.py \ + --dp3_path $DP3 \ + --wsclean_cmd $WSCLEAN \ + --restore_args "-j 14" \ + --input_ms [path_to_input_ms] \ + --work_dir $PWD \ + --config /ska-sdp-wflow-selfcal/config/LOFAR.averaged.yml \ + --run_single_operation False \ + --ignore_version_errors True +``` \ No newline at end of file