Installation

Prerequisites

pipx

pipx is a very useful tool to install and run Python applications in isolated environments. If you do not have it already, please follow the installation instructions here. Verify the installation is successful by running:

pipx --version

poetry

poetry is the official Python package manager for SKAO repositories. You can install it easily with pipx:

pipx install poetry

Verify the installation is successful by running:

poetry --version

Installing the batch pre-processing pipeline

Note

If you plan on developing, please first read Developer Guide.

Clone the repository

Navigate to the parent directory of your choice and run:

git clone https://gitlab.com/ska-telescope/sdp/science-pipeline-workflows/ska-sdp-batch-preprocess.git

Create a Python environment

It is highly recommended to install the pipeline inside a dedicated environment. Poetry will create one automatically if its configuration parameter virtualenvs.create is true.

poetry config virtualenvs.create true
cd ska-sdp-batch-preprocess/
poetry install

The pipeline and its dependencies should now be installed in a .venv/ sub-directory.

Activate the environment and verify the installation

The environment we just created needs to be activated so that the pipeline application(s) become available globally in our terminal:

source .venv/bin/activate

Verify that you can now run:

ska-sdp-batch-preprocess --version