Package: caracal
CARACalCARACal stands for Containerized Automated Radio Astronomy Calibration and is a pipeline for radio interferometry data reductionMain website:caracal.rtfd.ioIt includes the Install & Run instructions described below, and much more.Installation & RunUsage and publication policyWhen using CARACal please be aware of and adhere to theCARACal publication policy.RequirementsPython3.8 or higher.Container technology of your choice. It can be one of the following:DockerPodmanSingularity3.5 - 3.9 (nearly all functionality available for > 2.6.0-dist, seeherefor further information)Apptainerdoes not support all CARACal functionalities (at the moment).InstallationWe strongly recommend and describe an installation using aPython3virtual environment. Only try outside a virtual environment if you know what you are doing. Any name as${name}occurring in the description below can be chosen arbitrarily. If it symbolises directories or files, those directories or files should exist and the user should havewriteaccess.There are three (3) available methods to install thecaracalpipeline:1. ManualChoose the name of the virtual environment${caracal-venv}. Then:$python3-mvenv${caracal-venv}OR, if the command above does not workvirtualenv-ppython3${caracal-venv}source${caracal-venv}/bin/activatepipinstall-UpipsetuptoolswheelFor a CARACal stable release run:pipinstall-UcaracalCARACal has a few optional dependencies (scipy, astropy, regions, astroquery) which are not installed by default. But to get full functionality, you can install them by running:pipinstall-Ucaracal[all]And CARACal developer version which is not recommended for users:pipinstall-U'caracal[all] @ git+https://github.com/caracal-pipeline/caracal.git@master'Ignore any error messages concerning `pyregion`.2.caratekit.shscriptDownload the installation scriptcaratekit.sh. Choose the parent directory${workspace}and the name of the CARACal directory${caracal_dir}. Any name as${name}occurring in the description below can be chosen arbitrarily. If it symbolises directories or files, those directories or files should exist and the user should have write acccess.If usingDocker:caratekit.sh-ws${workspace}-cr-di-ct${caracal_dir}-rpinstall-f-khIf usingSingularity:caratekit.sh-ws${workspace}-cr-si-ct${caracal_testdir}-rpinstall-f-kh3. Poetry (For developers)Installation from source usingpoetry. First, install poetry:pipinstallpoetryIn the working directory where source is checked out runpoetry installor to include all optional dependencies:poetryinstall--extrasallInstallation on (ILIFU) slurm environmentThe installation of CARACal on ilifu has been tried and tested on the Ubuntu 20.0 operating system, although, it should also work on other OS versions. On the login node, follow these instructions:cd/path/to/working/areamoduleaddpython/3.9.4python3-mvenv<venv-name>source<venv-name>/bin/activatepipinstall-Upipsetuptoolswheelgitclonehttps://github.com/caracal-pipeline/caracal.gitpipinstall-U-ecaracaldeactivatewhere/path/to/working/areais the actual path to the directory where you wish to install CARACal.
In principle, this can also be done in the Slurm environment of ILIFU by submitting ansbatchscript.
Please amend yourpip installcommand with[all]option when needed in accordance with the instructions above.
Install the latest release with:pipinstall-UcaracalNB: The stimela singularity images needed for CARACal are stored in this location:/software/astro/caracal/where you can access the latest version of the images, for example,/software/astro/caracal/STIMELA_IMAGES_1.7.0.RunningIf you installed CARACal manually, activate the virtual environment with:source${caracal-venv}/bin/activateIf you installed CARACal with thecaratekit.shscript, activate the virtual environment with:source${workspace}/${caracal_dir}/caracal_venv/bin/activateIf usingDockerrun CARACal with:caracal-c${your-configuration-file}If usingSingularityrun CARACal with:caracal-ctsingularity-c${your-configuration-file}For more detailed installation instructions, troubleshooting tips and a full user manual please seecaracal.readthedocs.io.New issuesWe encourage users who experience problems installing or running CARACal to check for known issues or open a new issue at
ourGitHub issues page.When opening a new issue, please include your:installation type (e.g., Docker, Singularity)software version (both CARACal and Stimela)CARACal configuration fileCARACal log files.In case you arenotcarrying out a fresh installation, remove earlier Stimela images with:stimelaclean-acThen, if usingDocker:stimelapullIf usingSingularity, choose a pull folder${singularity_pull_folder}, where theSingularityimages are stored and define an environment variable by adding this in the rc file of your shell (e.g. .bashrc):exportSINGULARITY_PULLFOLDER=${WORKSPACE_ROOT}/singularity_imagesand run:stimelapull-sIf usingPodman:stimelapull-pLicenseThis project is licensed under the GNU General Public License v2.0 - seelicensefor details.ContributeContributions are always welcome! Please ensure that you adhere to our coding
standardspep8.