Installation

There are two primary ways to install S2SCAT. One can either build the project from the most recent GitHub source, which comes with the added benefit of being able to locally execute the unit testing. Alternately, one may simply install the package directly from PyPi, an online python package manager.

Quick install (PyPi)

The simplest way to pick up S2SCAT is to install the core JAX functionality directly from PyPi by running

pip install s2scat

after which S2SCAT may be imported and run as outlined in the associated notebooks and collab tutorials. This will include PyTorch functionality.

Install from source (GitHub)

When installing from source we recommend working within an existing conda environment, or creating a fresh conda environment to avoid any dependency conflicts,

conda create -n "env_name" python>=3.11
conda activate "env_name"

Once within a fresh environment S2SCAT may be installed by cloning the GitHub repository and pip installing locally

git clone https://github.com/astro-informatics/s2scat
cd s2scat
pip install .

from the root directory of the repository. This will include PyTorch functionality.

Unit tests can then be executed to ensure the installation was successful by first installing the test requirements and then running pytest

pip install -r requirements/requirements-tests.txt
pytest tests/

Documentation for the released version is available here. To build the documentation locally run

pip install -r requirements/requirements-docs.txt
cd docs
make html
open _build/html/index.html

Installing JAX for NVIDIA GPUs

We include both jax and jaxlib as dependencies in requirements/requirements-core.txt however to get things running on GPUs can be a bit more involved. We strongly recommend this installation guide provided by Google. To summarise you will first need to install NVIDIA drivers for CUDA and CuDNN, following which a pre-built CUDA-compatible wheels shoulld be installed by running

pip install --upgrade pip

# Wheels only built for linux
pip install --upgrade "jax[cuda]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html

# Wheels built for many machine architectures
pip install "jax[cuda11_cudnn86]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html

where the versions of CUDA and CuDNN should match those you have installed on the machine.