general

General pipeline information, including data IDs, and prefixes for output files.

title

str, optional, default = ‘ ‘

An optional project title.

msdir

str, optional, default = msdir

Location where CARACal will write and expect to find .MS files. The only exception is that of read-only input .MS files, which can be located in rawdatadir (see below).

rawdatadir

str, optional, default = ‘ ‘

If set to an empty string this parameter is ignored. If not set to an empty string, this is the directory where CARACal expects to find the input .MS files. This directory and the input .MS files within it can be reado-only, which makes it possible to work on large data without moving them within a shared machine. Any .MS file further created by CARACal is still written to msdir (see above).

input

str, optional, default = input

Location where CARACal expects to find various input files (e.g., RFI flagging strategy files).

output

str, optional, default = output

Location where CARACal writes output products.

prefix

str, optional, default = caracal

Prefix for CARACal output products.

prep_workspace

bool, optional, default = True

Initialise the pipeline by copying input files (i.e. those that are MeerKAT specific, flagging strategies, beam model, etc.).

init_notebooks

list of str, optional, default = std-progress-report, project-logs

Install standard radiopadre notebooks, given by list of basenames.

report_notebooks

list of str, optional, default = detailed-final-report

Like init_notebooks, but will also be automatically rendered to HTML when report=True in a worker

final_report

bool, optional, default = False

Render report_notebooks to HTML at the end of each pipeline run

backend

{“docker”, “udocker”, “singularity”, “podman”}, optional, default = docker

Which container backend to use (docker, udocker, singularity, podman)

cabs

list of map, optional, default = ‘ ‘

Specifies non-default image versions and/or tags for Stimela cabs. Running with scissors: use with extreme caution.