Mondaic

salvus.opt.utils

salvus.opt.utils salvus opt utils

Utility functions for inverse problems.

Functions

gradient_parameterization_from_fields()

def gradient_parameterization_from_fields(fields: set[str]) -> str: ...

Deduce a suitable gradient parameterization from a list of inversion parameters and physics.

Parameters
  • fields set[str] — Set of model parameters.
Returns str — Gradient parameterization string for SalvusCompute.

sum_gradients()

def sum_gradients(
    iteration: Iteration[ModelType], events: typing.Sequence[str], name: str
) -> ModelType: ...

Return the sum of a list of gradients from an iteration. This.

Parameters
  • iteration Iteration[ModelType] — Iteration object.
  • events typing.Sequence[str] — List of events to sum their gradients.
  • name str — Name of the summed model.
Returns ModelType — Summed model.