Installing ANTARESS#

Latest stable release#

ANTARESS is available on the PyPI repository. You can install the latest version available with:

pip install antaress

Current version#

ANTARESS is hosted on gitlab. To download the repository containing the current version, you can use:

git clone https://gitlab.unige.ch/spice_dune/antaress.git

This version is being developed and may not be stable.

The pipeline runs on Mac, Linux, and Windows (pySME is however not available on the latter).

Manual installation#

If you intend to develop or get the latest (unreleased) developments, get the current version as described above, move in the downloaded directory, and install ANTARESS with:

pip install -e .

If you want to test updates to the documentation as well, you will need to install the packages sphinx, myst-nb, and sphinx-book-theme with pip. You can then generate the documentation by moving to the /Docs folder and executing:

./Make_doc

The documentation will be generated in the /Docs/build/html/ folder, and can be checked by opening the index.html file.

Secondary packages#

A number of packages are required to run ANTARESS. They should be installed automatically, but if you encounter some trouble you can install them manually as described below.

Standard packages
Install arviz, astropy, batman-package, dace_query, emcee, dynesty, lmfit, pandas, pysme-astro, barycorrpy, ptemcee, torch, torchvision, tqdm, adjustText, pyro-ppl, pathos, PyAstronomy, scipy, statsmodels, imageio using:
pip install package
Resampling package
- bindensity documentation
- install as a standard package:
  pip install bindensity
- do not use bindensity with non-continuous grids, as it will mess up with banded covariance matrices.
- beware when masking spectral ranges with ANTARESS, as undefined pixels (set to nan values) are propagated by bindensity when resampling and will spread throughout the workflow.

HPC specifics#

ANTARESS is designed to work seamlessly on HPC systems without requiring administrator privileges. The package includes statically-linked versions of libcerf and gsl, which are automatically downloaded and compiled during installation if not found on your system.

Build Requirements

For the automatic compilation to succeed, you need:

A C compiler (gcc or clang)
cmake (version 3.0 or higher)
Standard build tools (make, tar, wget)

Most HPC systems provide these tools through environment modules. Before installing ANTARESS, load the required modules:

# Find available cmake modules
module spider cmake
# or
module avail cmake

# Load cmake (adjust version as needed)
module load cmake

# Then install ANTARESS
pip install antaress

Pre-built Wheels

If your HPC system runs a recent Linux distribution (Ubuntu 22.04+, Debian 12+, Rocky Linux 9+, etc.), you may receive a pre-built wheel that works without any compilation. In this case, no build tools are needed.

Troubleshooting

If installation fails:

Ensure build tools are available: gcc --version && cmake --version
Check that you have sufficient disk space in your home directory (GSL + libcerf require ~50MB during build) and ANTARESS has a decent number of depencies
Try installing in a virtual environment: python -m venv myenv && source myenv/bin/activate

For installation issues on any supported platform listed in the README, please open an issue with:

Your operating system and version
Output of gcc --version and cmake --version
The full error message from pip

We will help you resolve the problem promptly.

Installing ANTARESS

Contents