Required
project| Type: | Project |
| Description: | The project for the component. |
class InversionActionComponent(builtins.object):
def __init__(self, project: Project): ...| Type: | Project |
| Description: | The project for the component. |
def compute_gradients(
self,
simulation_configuration: str,
misfit_configuration: str,
events: str | list[str] | Event | list[Event] | EventCollection,
site_name: str,
ranks_per_job: int,
wall_time_in_seconds_per_job: salvus._core.types.float_ | None = None,
memory_per_rank_in_MB: float | None = None,
max_events_per_job_submission: int = 0,
wavefield_compression: WavefieldCompression | None = None,
gradient_parameters: set[str] | None = None,
delete_dependent_jobs: bool = True,
verbosity: int = 0,
) -> dict[str, pathlib.Path] | None: ...| Type: | str |
| Description: | Name of the simulation configuration for the forward run. |
| Type: | str |
| Description: | Name of the misfit configuration. |
| Type: | str | list[str] | Event | list[Event] | EventCollection |
| Description: | One or more events. |
| Type: | str |
| Description: | Site to use. |
| Type: | int |
| Description: | Ranks per job. |
| Type: | salvus._core.types.float_ | None |
| Default value: | None |
| Description: | Wall time per job. |
| Type: | float | None |
| Default value: | None |
| Description: | Optional memory settings for the site. |
| Type: | int |
| Default value: | 0 |
| Description: | Optional chunkwise job submission. If set to a positive number, simulations will be launched in chunks. |
| Type: | WavefieldCompression | None |
| Default value: | None |
| Description: | Wavefield compression settings. |
| Type: | set[str] | None |
| Default value: | None |
| Description: | Model parameters to compute the gradients for. Must be a subset of the model parameters. If not given, gradients will be computed for all model fields. |
| Type: | bool |
| Default value: | True |
| Description: | Delete job and all its dependencies at remote site after the outputs have been downloaded. |
| Type: | int |
| Default value: | 0 |
| Description: | Verbosity. |
def compute_misfits(
self,
simulation_configuration: str,
misfit_configuration: str,
events: str | list[str] | Event | list[Event] | EventCollection,
site_name: str,
ranks_per_job: int,
wall_time_in_seconds_per_job: salvus._core.types.float_ | None = None,
memory_per_rank_in_MB: float | None = None,
max_events_per_job_submission: int = 0,
derived_job_config: WavefieldCompression | None = None,
delete_dependent_jobs: bool = True,
verbosity: int = 0,
store_checkpoints: bool | None = None,
) -> dict[str, float] | None: ...| Type: | str |
| Description: | Name of the simulation configuration for the forward run. |
| Type: | str |
| Description: | Name of the misfit configuration. |
| Type: | str | list[str] | Event | list[Event] | EventCollection |
| Description: | One or more events. |
| Type: | str |
| Description: | Site to use. |
| Type: | int |
| Description: | Ranks per job. |
| Type: | salvus._core.types.float_ | None |
| Default value: | None |
| Description: | Wall time per job. |
| Type: | float | None |
| Default value: | None |
| Description: | Optional memory settings for the site. |
| Type: | int |
| Default value: | 0 |
| Description: | Optional chunkwise job submission. If set to a positive number, simulations will be launched in chunks. |
| Type: | WavefieldCompression | None |
| Default value: | None |
| Description: | Options that have an effect on the output of subsequent simulations but must already be known now. Currently allows the specification of some techniques to compress wavefields for the purpose of gradient computations. |
| Type: | bool |
| Default value: | True |
| Description: | Delete job and all its dependencies at remote site after the outputs have been downloaded. |
| Type: | int |
| Default value: | 0 |
| Description: | Verbosity. |
| Type: | bool | None |
| Default value: | None |
| Description: | Deprecated. Please use the derived_job_config parameter. |
def smooth_model(
self,
model: UnstructuredMesh | UnstructuredModel,
smoothing_configuration: (
ConstantSmoothing | ModelDependentSmoothing | SpaceDependentSmoothing
),
site_name: str,
ranks_per_job: int,
wall_time_in_seconds_per_job: salvus._core.types.float_ | None = None,
verbosity: int = 0,
run_async: bool = False,
) -> UnstructuredMesh | SalvusJobArray: ...| Type: | UnstructuredMesh | UnstructuredModel |
| Description: | Input model (gradient) that should be smoothed. |
| Type: | ConstantSmoothing | ModelDependentSmoothing | SpaceDependentSmoothing |
| Description: | Smoothing configuration. |
| Type: | str |
| Description: | Site to use. |
| Type: | int |
| Description: | Ranks per job. |
| Type: | salvus._core.types.float_ | None |
| Default value: | None |
| Description: | Wall time per job. |
| Type: | int |
| Default value: | 0 |
| Description: | Verbosity. |
| Type: | bool |
| Default value: | False |
| Description: | Optional switch to run smoothing asynchronously. This is mainly for internal use. |
simulation_configuration,
misfit_configuration and events.def sum_gradients(
self,
simulation_configuration: str,
misfit_configuration: str,
events: str | list[str] | Event | list[Event] | EventCollection,
wavefield_compression: WavefieldCompression | None = None,
gradient_parameters: set[str] | None = None,
) -> UnstructuredMesh: ...| Type: | str |
| Description: | Name of the simulation configuration for the forward run. |
| Type: | str |
| Description: | Name of the misfit configuration. |
| Type: | str | list[str] | Event | list[Event] | EventCollection |
| Description: | One or more events. |
| Type: | WavefieldCompression | None |
| Default value: | None |
| Description: | Wavefield compression for the gradients to choose. |
| Type: | set[str] | None |
| Default value: | None |
| Description: | Model parameters to compute the gradients for. Must be a subset of the model parameters. If not given, gradients will be computed for all model fields. |