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.
Mondaic distributes its software through a small utility program, called the Mondaic Downloader. To invoke it, simply execute, on Linux and macOS:
bash -c "$(curl -sSL https://get.mondaic.com)"
or on Windows execute
powershell -command "iex (New-Object System.Net.WebClient).DownloadString('https://get.mondaic.com/win')"
in any terminal prompt. In case you are hesitant about directly running an unknown script via piping into bash, that script and how to manually do what it does, is explained at the end of this page.
You need a Mondaic account to use the Downloader. If you do not have one yet or forgot your credentials, please contact us.
The Downloader will always download things to the machine where it is run, so the general strategy is to run it on the machine where you want to install things. On dark sites without internet access we recommend to run the Downloader on another machine and manually copy the files.
The Downloader will ask you a number of interactive questions. Most should be self-explanatory. A few things to note:
At a certain point it will present you with a choice of products to download.
Salvus
: SalvusCompute binary for single precision calculations.SalvusF64
: SalvusCompute binary for double precision calculations. The
single precision binary is sufficient for the vast majority of applications --
only use the double precision version if you need it. The double precision
version is twice as slow and uses twice as much memory.mpi
: A pre-compiled version of MPICH. Use on laptops and local
workstations, on an HPC use the cluster provided MPI.SalvusPy
: The Salvus Python package.There is no need to install SalvusCompute
and the downloader will choose a
precompiled binary tailored to your architecture. The only thing left to do
is to install the Python package. Make sure that you have succesfully setup
and activated the Python environment
before installing it with pip
:
pip install ~/Salvus/python_packages/salvus-*.whl
If you did not use the default location for the download, you might have to adjust the path above.
Running the downloader again will ensure all local files are updated to the
latest available version. It will download anything that
misses/has been updated and keep your folder structure in consistent state.
You then might have to invoke pip install ...
again and reinitialize any
sites.
The first command on this page downloads a script located at https://get.mondaic.com and executes it via bash. If you visit this page you can see that it determines your operating system, and then proceeds to download the corresponding binary of the Mondaic Downloader.
You are free and very welcome to do this manually if you prefer to. The only caveat here is that we update the Mondaic Downloader frequently without prior notice. As long as you make sure to work with an up-to-date version everything will work fine.
Running the downloader with
MONDAIC_LOG_LEVEL=salvus_downloader=debug bash -c "$(curl -sSL https://get.mondaic.com)"
will cause a lot more diagnostic output to be printed to the console. In case you encounter any problems we recommend to run it like this. If the problem persists, please send us the result of the debug output.