Installation

Prerequisites

poetry is the recommended Python package manager for this repository. Install pipx by following the official installation instructions, then install poetry:

pipx install poetry

Installing the package

Ensure that the package is installed in a dedicated virtual environment, rather than globally, by running the following command:

poetry config virtualenvs.create true

First, clone the repository from here and move into the project directory:

git clone https://gitlab.com/ska-telescope/sdp/ska-sdp-continuum-imaging-qa.git
cd ska-sdp-continuum-imaging-qa

Install the package and its dependencies using Poetry. For development (includes docs, tests, etc.), add the --all-extras flag:

# Install the package and its dependencies
poetry install

# Alternatively, install all extras for development
poetry install --all-extras

The project will be installed in a .venv/ directory within the project directory. You can verify the installation by activating the virtual environment and running the CLI command:

source .venv/bin/activate
ska-sdp-continuum-imaging-qa --help