caracal 1.1.3rc1

1. Manual

Choose the name of the virtual environment ${caracal-venv}. Then:

python3 -m venv ${caracal-venv}

OR, if the command above does not work

virtualenv -p python3 ${caracal-venv}

For a CARACal stable release run:

pip install -U caracal

CARACal 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:

pip install -U caracal[all]

And CARACal developer version which is not recommended for users:

pip install -U 'caracal[all] @ git+https://github.com/caracal-pipeline/caracal.git@master'

Ignore any error messages concerning pyregion.

2. caratekit.sh script

Download the installation script caratekit.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 using Docker:

caratekit.sh -ws ${workspace} -cr -di -ct ${caracal_dir} -rp install -f -kh

If using Singularity:

caratekit.sh -ws ${workspace} -cr -si -ct ${caracal_testdir} -rp install -f -kh

3. Poetry (For developers)

Installation from source using poetry. First, install poetry:

pip install poetry

In the working directory where source is checked out run poetry install or to include all optional dependencies:

poetry install --extras all

pip install -U caracal

NB: 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.