This tutorial is presented as Python code running inside a Jupyter Notebook, the recommended way to use Salvus. To run it yourself you can copy/type each individual cell or directly download the full notebook, including all required files.

Full-Waveform Inversion

Part 4 - Iterations

%matplotlib inline
import numpy as np
import os
import salvus.namespace as sn
SALVUS_FLOW_SITE_NAME = os.environ.get("SITE_NAME", "local")
p = sn.Project(path="project")
The inverse problem is a similar entity like all the other configuration objects. We want to be able to keep track of all the individual steps, and avoid unnecessary repetitions of the same task. Fortunately, SalvusProject takes care of data management and book keeping.
We need to specify the prior, which is just the SimulationConfiguration object of the initial model we created above. Furthermore, we need to specify all possible events that we might consider during the inversion. This could be a subset of events defined in the project, and we could add more events later on. Together with the events, we need to pass the observed data. Because we created it synthetically, this is also just a SimulationConfiguration object. The remaining parameters specify which parameters to invert for (VP and RHO), what misfit functional to use, preconditioner and descent method, and where to run the simulations.
p += sn.InverseProblemConfiguration(
    mapping=sn.Mapping(scaling="absolute", inversion_parameters=["VP", "RHO"]),
    preconditioner=sn.ConstantSmoothing({"VP": 0.01, "RHO": 0.01}),
        site_name=SALVUS_FLOW_SITE_NAME, ranks_per_job=4
Instead of monolithic inversions and a linear flow of iteration, SalvusOpt uses a tree-based framework of iteration. At any point during the inversion, you can branch off, modify the settings, and run one or more streams simultaneously.
Ready for our first iteration? Without specifying any additional information, all parameters will be inherited from the InverseProblemConfiguration.
[2024-07-05 10:12:04,744] INFO: Adding new iteration #0.
Many steps within a single iteration involve expensive simulations, e.g., for computing misfits or adjoint simulations to compute gradients. In order to be able to closely monitor the progress, SalvusOpt steps through an iteration, and automatically dispatches simulations whenever necessary. The function resume will return whenever SalvusOpt is waiting for other tasks to finish first. Calling it several time, will step through the iteration in sequence.
[2024-07-05 10:12:04,760] INFO: Resuming iteration #0.
Current stage: initialize
[2024-07-05 10:12:04,760] INFO: 1 new tasks have been issued.
[2024-07-05 10:12:04,761] INFO: Processing task `misfit_and_gradient`
[2024-07-05 10:12:05,137] INFO: 
Iteration 0: Number of events: 5	 chi = 0.017690076157774178	 ||g|| = 0.02256501205974222
pred = ---	ared = ---	norm_update = ---	tr_radius = ---
[2024-07-05 10:12:05,140] INFO: 1 new tasks have been issued.
[2024-07-05 10:12:05,140] INFO: Processing task `preconditioner`

[2024-07-05 10:12:05,325] INFO: Some tasks of iteration #0 are still running. Please check again later.
[2024-07-05 10:12:05,336] INFO: Resuming iteration #0.
Current stage: compute_trial_model
[2024-07-05 10:12:05,336] INFO: Processing task `preconditioner`
[2024-07-05 10:12:05,369] INFO: Some tasks of iteration #0 are still running. Please check again later.
    inverse_problem_configuration="my_inversion", iteration_id=0
If you feel confident and don't want to be bothered with every single task, you can also tell SalvusOpt to run an entire iteration at once. Note the parameter timeout_in_seconds, which will force the cell to return even if the iteration has not been completed yet, and there might still be a few simulations running in the back.
Again, you can execute the cell several times or mix it with calls to the previous one until the iteration is complete.

[2024-07-05 10:12:05,839] INFO: Resuming iteration #0.

[2024-07-05 10:12:05,840] INFO: Processing task `preconditioner`
[2024-07-05 10:12:05,860] INFO: Some tasks of iteration #0 are still running. Please check again later.
[2024-07-05 10:12:15,861] INFO: Processing task `preconditioner`
[2024-07-05 10:12:15,986] INFO: 1 new tasks have been issued.
[2024-07-05 10:12:15,986] INFO: Processing task `misfit`
[2024-07-05 10:12:16,187] INFO: Submitting job array with 5 jobs ...

[2024-07-05 10:12:16,300] INFO: Launched simulations for 5 events. Please check again to see if they are finished.
[2024-07-05 10:12:16,301] INFO: Some tasks of iteration #0 are still running. Please check again later.
[2024-07-05 10:12:26,313] INFO: Processing task `misfit`
[2024-07-05 10:12:27,083] INFO: 
old misfit control group: 0.017690076157774175
new misfit control group: 0.006215537426211551
predicted reduction control group: -0.009679722626408399
actual reduction control group: -0.011474538731562624
5 out of 5 event(s) improved the misfit.
[2024-07-05 10:12:27,083] INFO: 
Model update accepted.
[2024-07-05 10:12:27,084] INFO: 1 new tasks have been issued.
[2024-07-05 10:12:27,084] INFO: Processing task `finalize_iteration`
[2024-07-05 10:12:27,108] INFO: Succesfully completed iteration #0.
[2024-07-05 10:12:27,110] INFO: Adding new iteration #1.