SKA-Low Commissioning Tools

Installation

These tools require the following utilities to be installed and available on the user’s PATH:

Monolithic CASA 6. Note that, unfortunately, modular CASA conflicts with python-casacore and cannot be installed in the same Python environment.
AOFlagger
AOCalibrate

To install the tools themselves, just use pip:

pip install \
    git+https://gitlab.com/ska-telescope/ssc/ska-ssc-low-comm-tools.git \
    --extra-index-url=https://artefact.skao.int/repository/pypi-internal/simple
# extra index is required to install SKA-hosted tooling

Note that some scripts require SKA-SDP tooling. These can be obtain using the ska-sdp pip extra:

pip install \
    "git+https://gitlab.com/ska-telescope/ssc/ska-ssc-low-comm-tools.git#egg=project[ska-sdp]" \
    --extra-index-url=https://artefact.skao.int/repository/pypi-internal/simple
# extra index is required to install SKA-hosted tooling

Usage

Full documentation is available here.

Commandline tools

All commandline tools start with:

low_...

Scripts which run inside of CASA have:

low_casa_...

See the following docs pages for the full list of tools and their arguments:

Python API

The Python API has automatically generated documentation here.

Development

Clone and install. Optional groups are dev and docs - install as required.

git clone https://gitlab.com/ska-telescope/ssc/ska-ssc-low-comm-tools.git
cd ska-low-commissioning-tools
pip install -e .[dev] --extra-index-url=https://artefact.skao.int/repository/pypi-internal/simple
# extra index is required to install SKA-hosted tooling

Optionally install pre-commit

cd ska-low-commissioning-tools
pre-commit install
pre-commit run --all-files

Test with pytest

cd ska-low-commissioning-tools
pytest --cov low_comm_tools