Salvus and Python

Salvus, except for the compute binary, comes as a single Python package, SalvusPy.

Please note that Python is not necessary for SalvusCompute to run on HPC systems and other large clusters.

Setting up Python

Salvus currently requires an installation of Python 3.11. There are different ways to set this up and most should work fine. We recommend to install the latest Miniforge distribution.

Please note that the user is responsible for complying with the licenses provided by any Python package installed and used.

Installing the dependencies

Assuming you are following our recommendation of using Miniforge, you can, after installing it, proceed with the instructions below.

The environment.yml describes a Python envionment containing all dependencies required to run Salvus. Additionally, it contains the Jupyter project, which we recommend as an interface to Salvus.

Run the following command to obtain the list of dependencies.

Copy
curl https://docs.mondaic.com/environment-py311.yml -o environment.yml

If the above does not work, you can also right click to manually download the yaml file.

The next block will now install all Python packages listed in the environment.

Copy
# Create a new environment with all required dependencies.
mamba env create -n salvus -f environment.yml
# Activate that environment.
mamba activate salvus

By now there should be some indication in your shell that you have an active Salvus Python environment. Remember to always activate it, otherwise Salvus will not be available.

Please note that this only installed the dependencies of Salvus, Salvus itself will be installed by following the instructions here.

Python environments for older versions of Salvus

The above environment file is intended and tested for the latest release of Salvus. For older versions and previous releases, we maintain the legacy environment files listed below.

Salvus 2024.1.3

Copy
curl https://docs.mondaic.com/environment-salvus-2024.yml -o environment.yml

Salvus 0.12.16

Copy
curl https://docs.mondaic.com/environment-salvus-12.yml -o environment.yml

In case you run into any issues using an older version of Salvus, please contact [email protected], and we will help you upgrading.