astrohack 0.0.1

Holography Antenna Commissioning Kit

sirius

SiRIUS is a component list radio interferometry visibilities simulator in development for the VLA, ALMA, and the ngVLA telescopes. It makes use of modular Common Astronomy Software Applications (CASA), the CASA Next Generation Infrastructure framework (CNGI), and dask-ms (dask-ms).

📝 SiRIUS is under active development! Breaking API changes are still happening on a regular basis, so proceed with caution.

Installing

It is recommended to use the conda environment manager to create a clean, self-contained runtime where sirius and all its dependencies can be installed:

conda create --name sirius python=3.8 --no-default-packages
conda activate sirius

📝 On macOS it is required to pre-install python-casacore using conda install -c conda-forge python-casacore. After this is fixed upstream, documentation for installing sirius using virtualenv will be added here.

Making sirius available for download from conda-forge directly is pending, so until then the current recommendation is to sully that pristine environment by calling pip from within conda, like this:

pip install sirius

The basic dependency versions fixed to a given release are frozen using pip list --format=freeze > requirements.txt.

Developer installation

Developers build and install sirius from their local clones of the source code. With their base conda environment active, pip install -e .[complete]. Specifying the [complete] install will download extras, including pre-commit (required for committing code changes that pass the linter) and pytest (which is helpful for running unit tests locally). In addition to development extras, the packages required to build the documentation can be installed locally from source using

pip install -e .[docs]

The complete dependency versions fixed to a given release are frozen using pip list --format=freeze > requirements-dev.txt.

It is also possible to download directly from the requirements files using pip install -r requirements.txt or pip install -r requirements-dev.txt, just be aware that it might not be confirmed to be compatible with bleeding edge development between release tags.

Before committing to a branch pre-commit should be installed:

conda install -c conda-forge pre-commit
cd sirius #source directory
pre-commit install