How to install

The pipeline is available in two forms:

As a pip-installable Python package, which requires a working AIPS installation.
As a Docker container, which simplifies the setup

The Docker container is easy to use, but building and running it requires sudo privileges. A Singularity image is currently being worked on, which will allow the pipeline to run on servers without sudo access.

Requirements

Before installing, make sure you have the following software available:

Manual installation:

AIPS 31DEC24 or newer
Conda

Docker installation:

Docker
XQuartz (only in MacOS)
sudo privileges

Installation

Getting the pipeline up and running is simple. Below we describe the recommended steps for the different installations.

Manual Installation

Clone the repository:

git clone https://github.com/dalvarezo/VIPCALs.git

Create the conda environment:

cd VIPCALs
conda env create -f vipcalsenv.yml

Activate the conda environment and install with:
```
conda activate pyside62
pip install .
```

You can now launch VIPCALs with:

vipcals

Docker Installation

Clone the repository:

git clone https://github.com/dalvarezo/VIPCALs.git

Build the Docker container:

sudo docker build -t vipcals ./VIPCALs/dockerfiles/

Run it (Linux):
```
sudo docker run -it --rm --net=host \
  -e DISPLAY=$DISPLAY \
  -e QT_X11_NO_MITSHM=1 \
  -v /tmp/.X11-unix:/tmp/.X11-unix \
  -v /your_directory/:/home/vipcals vipcals
```
or (MacOS)
```
xhost +127.0.0.1
docker run -it \
  -e DISPLAY=host.docker.internal:0 \
  -v /tmp/.X11-unix:/tmp/.X11-unix \
  -v /your_directory/:/home/vipcals vipcals
```
where /your_directory/ has to be replaced with the local directory where you wish to work. This directory should contain your data and any subfolders you want the pipeline to access.

In MacOS, make sure that both DockerDesktop and XQuartz are running, and that XQuartz → Preferences → Security → “Allow connections from network clients” is checked on.