Mondaic DocumentationRequired
project| Type: | Project |
| Description: | Project to be registered. |
Version:
2026.5.0
Salvus documentation version
2026.5.0
2025.1.3
2024.1.3
0.12.16
No results found.
salvus.project.components.action.validation.validation_action_component
salvus.project.components.action.validation.validation_action_component salvus project components action validation validation_action_componentValidation action component.
Classes
ValidationActionComponent
Initialize the action component.
SIGNATURE
class ValidationActionComponent(builtins.object):
def __init__(self, project: Project): ...ARGUMENTS
Methods
ValidationActionComponent.validate_data_processing()
Validate the data processing.
SIGNATURE
def validate_data_processing(
self,
data_name: str,
receiver_field: str,
events: (
str
| typing.Sequence[str]
| typing.Sequence[Event]
| EventCollection
| None
) = None,
time_axis: TimeAxis | None = None,
) -> None: ...ARGUMENTS
Required
data_name| Type: | str |
| Description: | Name of the data to validate. |
Required
receiver_field| Type: | str |
| Description: | Receiver field to validate (e.g., "displacement"). |
Optional
events| Type: | str | typing.Sequence[str] | typing.Sequence[Event] | EventCollection | None |
| Default value: | None |
| Description: | List of events to validate. If None, it will validate all events in the project. |
Optional
time_axis| Type: | TimeAxis | None |
| Default value: | None |
| Description: | Try to retrieve the data on a prescribed time axis. If no time axis is provided, the data is retrieved on its native time axis. |
ValidationActionComponent.validate_model_gradients()
Measure the error of the model gradients computed in Salvus.
SIGNATURE
def validate_model_gradients(
self,
simulation_configuration: str,
misfit_configuration: str,
wavefield_compression: WavefieldCompression,
events: str | list[str] | Event | list[Event] | EventCollection,
parameters: str | list[str],
h: list[salvus._core.types.float_],
site_name: str,
ranks_per_job: int,
wall_time_in_seconds_per_job: salvus._core.types.int_ | None = None,
sleep_interval: salvus._core.types.float_ = 1.0,
) -> dict: ...ARGUMENTS
Required
simulation_configuration| Type: | str |
| Description: | Simulation configuration to test. |
Required
misfit_configuration| Type: | str |
| Description: | Misfit configuration to test. |
Required
wavefield_compression| Type: | WavefieldCompression |
| Description: | Wavefield compression settings. |
Required
events| Type: | str | list[str] | Event | list[Event] | EventCollection |
| Description: | Events to test. |
Required
parameters| Type: | str | list[str] |
| Description: | Model parameters to test. |
Required
h| Type: | list[salvus._core.types.float_] |
| Description: | An array of relative model perturbations. |
Required
site_name| Type: | str |
| Description: | Site on which to run the tests. |
Required
ranks_per_job| Type: | int |
| Description: | Number of ranks on which to run the tests. |
Optional
wall_time_in_seconds_per_job| Type: | salvus._core.types.int_ | None |
| Default value: | None |
| Description: | Wall time per test job. Defaults to None. |
Optional
sleep_interval| Type: | salvus._core.types.float_ |
| Default value: | 1.0 |
| Description: | Sleep interval between querying job status. Defaults to 1.0. |
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS