Salvus Documentation and Usage Guide
Install Salvus, run a first simulation, or jump straight to the reference you need.
Install or Download Salvus
Choose your operating system and follow the installation steps.
Open the GuideRun Your First Simulation
Start with a complete, guided example of Lamb’s problem.
Open the GuideFind Examples and Tutorials
Explore workflows by application and topic.
Open the GuideLook Up the API
Find Python and SalvusCompute reference documentation.
Open the GuideRead Release Notes
See what changed in your version of Salvus.
Open the GuideGet Technical Help
Troubleshoot an issue, visit the forum, or contact support.
Open the GuideLooking for WScan? Use the WScan getting started guide or WScan support.
About Salvus
Salvus is a suite of software for performing full waveform modelling and inversion provided by Mondaic. Salvus aims to fuse the flexibility of research codes with the performance of production-grade software. It employs the spectral element method and works in 2-D and 3-D on quadrilateral and hexahedral meshes. A particular focus of our efforts is directed at usability and the proper solution of the inverse problem.
Our peer-reviewed and open-access paper describes some of the underlying methods in detail.
Salvus User Forum
The Salvus user forum is a great place to ask questions and learn from the experience of the wider Salvus community.
How to Use Salvus’ Documentation
This website serves to document how to install and use the various components of Salvus.
If you are new to Salvus, the getting started guide explains the software and suggests a learning path.
The menu at the top (or hidden behind the hamburger menu on mobile in the top left) grants quick access to all parts of this site, including an FAQ and selected publications using Salvus.
Documentation itself is largely split into six parts:
- Getting Started and Installation: Introduction and installation instructions.
- Updates: Mondaic regularly introduces new functionality. Learn what changed here.
- Knowledge Base: More in-depth documentation of the various parts of Salvus and their mathematical and physical background.
- Examples and Tutorials: A collection of examples and full tutorials teaching various aspects of Salvus ranging from basic introduction to detailed and complete applications.
- Reference Documentation: Detailed API references
- Data: Various data sets that are potentially useful and relevant when using Salvus.