Installation

Installing Salvus is a multi-step procedure that is very similar on every system. This page describes the general sequence, but for specific systems and the relevant procedure, we refer to the pages per OS as can be selected below.

Please note that when running Salvus on remote systems (like workstations), Salvus can be remotely installed both using these instructions, or during the Salvus flow configuration from your local system. If using the latter process, only the wave simulation binaries will be remotely installed, and not the Python interface. For more information on installing and running Salvus using remote compute resources, see the article Where to Run Things?

If you run into any problems please don't hesitate to contact us at [email protected] or any other provided support channel.

General installation process

On a high level, the Salvus installation process always has the following steps:

1. Install external prerequisites (e.g. Rosetta on MacOS, MPI on Windows). For this, make sure to select the right operating system above.
2. Set up an appropriate Python environment. This typically consists of:

• Installing Miniforge, a binary and package manager for Python;
• Installing the required Python version and external packages from our environment.yml files.
• Activating the environment to continue the installation process.

3. Run the Mondaic installer. This will guide you through the process of selecting the right files to download, including the SalvusCompute binaries, i.e. what runs the waveform simulations, and the right SalvusPy binaries, which runs the Python interface for all other functionality. The appropriate files are selected based on the operating system, available microarchitecture instructions
4. Install the just-downloaded SalvusPy files in the Python environment.
5. Finalize the installation by creating or (re-)initializing a Salvus site.

All files installed by Salvus itself will typically live in one directory (by default ~/Salvus on Linux, MacOS and WSL systems, %homedrive%%homepath%\Salvus on Windows).

The nature of this installation also makes it easy to install multiple versions of SalvusPy on the same system, by e.g. creating multiple Python environments and naming them according to the Salvus version one installs. Typically, any SalvusPy version can call an arbitrary SalvusCompute version, although we only guarantee compatibility for matching version numbers.s

Salvus should be all ready by now so time to learn how to use it. We recommend to start with this tutorial.