Version:

Installation

Installing Salvus is a multi-step procedure that is slightly different on every system. This page describes the recommended sequence in case you are new to using Salvus.

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

Operating Systems

Salvus is officially supported on Apple's macOS as well as most Linux distributions. Running on the Windows Subsystem for Linux on Windows 10 is possible by following these instructions, but Mondaic does not officially support it as of now.

Recommended Installation Sequence

We recommend the following 5 steps to install Salvus. This page contains a summary of them - each step is additionally detailed on its own page.

1. Where to Install

Details on where to run Salvus: Where to Run Things?

The first step to install Salvus is to figure out where every component of it will run. The most common case is to have a full installation locally and additionally install a version of SalvusCompute on a larger workstation or cluster.

2. Install Python Packages

Details on the Python installation: Python Packages

Salvus depends on Python and a number of third party packages. We recommend to use the Miniconda distribution: Install it from here. After installing it, please run the following commands to create a Salvus environment and install all dependencies:

Copy
# Download the environment description file.
curl https://mondaic.com/environment.yml -o environment.yml
# Create a new environment with all required dependencies.
conda env create -n salvus -f environment.yml
# Activate that environment.
conda activate salvus

3. Run the Downloader

Details on the Mondaic Downloader: Mondaic Downloader

To download Salvus and install the Salvus Python module run the following two commands:

# Run the Mondaic downloader.
bash -c "$(curl -sSL https://get.mondaic.com)"
# Install the Python Salvus package into the previously created conda
# environment.
pip install ~/Salvus/python_packages/salvus-*.whl

4. Configure SalvusFlow

Details on the SalvusFlow configuration: SalvusFlow Configuration

The last step is to teach Salvus how to run on your specific machine. Please run this interactive wizard to get started:

salvus-flow add-site

5. Start to Learn Salvus

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

PAGE CONTENTS