Mondaic
This API reference is not for the latest stable Salvus version.

salvus.project.tools.task_chains.compute_misfits_and_gradients.compute_misfits_and_gradients

Compute misfits and gradients for certain special cases.

Functions

compute_misfits_and_gradients_from_project()

def compute_misfits_and_gradients_from_project(
    project: salvus.project.project.Project,
    simulation_configuration: str,
    misfit_configuration: str,
    event_names: List[str],
    sites: Dict[
        str,
        salvus.flow.sites.task_chain.task_chain_site_config.TaskChainSiteConfig,
    ],
    wavefield_compression: salvus.flow.collections.wavefield_compression.WavefieldCompression,
) -> (
    salvus.project.tools.task_chains.compute_misfits_and_gradients.results.result_collection.ResultCollection
):
    ...

Compute misfits and gradients for a given Salvus project using distributed task chains.

As of now this only works for projects satisfying the following list of constraints:

  • The project and the Salvus run directory must reside on a shared file system that the process launching the task chain and all compute nodes have access to.
  • Events must be specified using an event block file.
Parameters
  • project salvus.project.project.Project — The project.
  • simulation_configuration str — The simulation configuration.
  • misfit_configuration str — The misfit configuration.
  • event_names List[str] — The event names.
  • sites Dict[str, salvus.flow.sites.task_chain.task_chain_site_config.TaskChainSiteConfig] — The sites’ configuration for running things.
  • wavefield_compression salvus.flow.collections.wavefield_compression.WavefieldCompression — Wavefield compression settings.
Returns salvus.project.tools.task_chains.compute_misfits_and_gradients.results.result_collection.ResultCollection

compute_misfits_from_project()

def compute_misfits_from_project(
    project: salvus.project.project.Project,
    simulation_configuration: str,
    misfit_configuration: str,
    event_names: List[str],
    sites: Dict[
        str,
        salvus.flow.sites.task_chain.task_chain_site_config.TaskChainSiteConfig,
    ],
) -> (
    salvus.project.tools.task_chains.compute_misfits_and_gradients.results.result_collection.ResultCollection
):
    ...

Compute misfits for a given Salvus project using distributed task chains.

Operates under the same constraints as the compute_misfits_and_gradients_from_project() function.

Parameters
  • project salvus.project.project.Project — The project.
  • simulation_configuration str — The simulation configuration.
  • misfit_configuration str — The misfit configuration.
  • event_names List[str] — The event names.
  • sites Dict[str, salvus.flow.sites.task_chain.task_chain_site_config.TaskChainSiteConfig] — The sites’ configuration for running things.
Returns salvus.project.tools.task_chains.compute_misfits_and_gradients.results.result_collection.ResultCollection