This page here has been created for the latest stable release of Salvus. You have chosen to view the documentation for another Salvus version. Please be aware there might be some small differences you have to account for.
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.
On a high level, the Salvus installation process always has the following steps:
environment.yml
files.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.