Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
project
/
components
/
simulation_component

salvus.project.components.simulation_component

salvus.project.components.simulation_component salvus project components simulation_component
SalvusProject simulation component.

Functions

get_simulation_input_file()

Create Salvus input file for a single event from a template.
SIGNATURE
def get_simulation_input_file(
    simulation_template: simple_config.simulation.Waveform,
    event: Event,
    event_configuration: EventConfiguration,
    project_path: pathlib.Path,
    event_dependent_mesh_masking: typing.Callable | None = None,
    wavefield_compression: WavefieldCompression | None = None,
    extra_output_configuration: dict[str, typing.Any] | None = None,
) -> simple_config.simulation.Waveform: ...
ARGUMENTS
Required
simulation_template
Type:simple_config.simulation.Waveform
Description:
Template for the simulation containing all non-event-dependent information, such as start/end time or a template for the boundary conditions.
Required
event
Type:Event
Description:
Event object to extract the source(s) and receivers from.
Required
event_configuration
Type:EventConfiguration
Description:
EventConfiguration object.
Required
project_path
Type:pathlib.Path
Description:
Root path to the project.
Optional
event_dependent_mesh_masking
Type:typing.Callable | None
Default value:None
Description:
Optional callback function for event- dependent mesh masking. The function signature must take the global mesh and the event as arguments. Boundary conditions will be applied automatically.
Optional
wavefield_compression
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. Must be given for checkpoints to be generated during the forward simulation.
Optional
extra_output_configuration
Type:dict[str, typing.Any] | None
Default value:None
Description:
Extra settings for the waveform simulations. Can only be used for settings that do not change the resulting waveforms. python extra_output_configuration={ "volume_data": { "sampling_interval_in_time_steps": 50, "fields": ["displacement"], }, "surface_data": { "sampling_interval_in_time_steps": 20, "fields": ["acceleration", "velocity"], "side_sets": ["x0", "x1"], }, "memory_per_rank_in_MB": 2000.0, }
RETURNS
Return type: simple_config.simulation.Waveform

Classes

SimulationComponent

Project subclass dealing with all things related to simulations. This explicitly includes meshes as for the project they largely exist for the purpose of simulations.
SIGNATURE
class SimulationComponent(builtins.object):
    def __init__(self, project: Project): ...
ARGUMENTS
Required
project
Type:Project
Description:
The project to attach the components to.

Methods

SimulationComponent.cancel()
Cancel ongoing or pending simulations. Note that if simulations for several events have been simultaneously submitted using simulations.launch(), all jobs in this job array will be cancelled.
SIGNATURE
def cancel(
    self,
    simulation_configuration: str | None = None,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
        | None
    ) = None,
    misfit_configuration: str | MisfitConfiguration | None = None,
    wavefield_compression: WavefieldCompression | None = None,
    gradient_parameters: set[str] | None = None,
) -> None: ...
ARGUMENTS
Optional
simulation_configuration
Type:str | None
Default value:None
Description:
Name of the simulation configuration.
Optional
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection | None
Default value:None
Description:
One or more events.
Optional
misfit_configuration
Type:str | MisfitConfiguration | None
Default value:None
Description:
Optional misfit configuration to query adjoint simulations
Optional
wavefield_compression
Type:WavefieldCompression | None
Default value:None
Description:
Must be given for adjoint simulations.
Optional
gradient_parameters
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.
SimulationComponent.cancel_all()
Cancel all running simulations.
All currently launched simulations that have not finished yet will be cancelled.
SIGNATURE
def cancel_all(self) -> None: ...
SimulationComponent.clear_simulation_store()
Remove all items from the simulation store. Try to delete dangling jobs on remote sites.
SIGNATURE
def clear_simulation_store(self) -> None: ...
SimulationComponent.delete_jobs()
Manually delete the jobs associated with a simulation configuration and events. By default, this happens automatically, when all remote output is downloaded with query() unless there still exists remote data.
SIGNATURE
def delete_jobs(
    self,
    simulation_configuration: str | SimulationConfiguration,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
    ),
    verbosity: int = 0,
) -> None: ...
ARGUMENTS
Required
simulation_configuration
Type:str | SimulationConfiguration
Description:
The simulation configuration.
Required
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection
Description:
One or more events.
Optional
verbosity
Type:int
Default value:0
Description:
Verbosity level.
SimulationComponent.delete_results()
Delete simulation results (waveforms, gradients, ...). The function does not delete the configuration, but only simulated data. Those data can be recomputed if necessary.
SIGNATURE
def delete_results(
    self,
    simulation_configuration: str,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
    ),
    misfit_configuration: str | None = None,
    wavefield_compression: WavefieldCompression | None = None,
    gradient_parameters: set[str] | None = None,
    verbosity: int = 1,
) -> int: ...
ARGUMENTS
Required
simulation_configuration
Type:str
Description:
The name of the simulation configuration.
Required
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection
Description:
One or more events.
Optional
misfit_configuration
Type:str | None
Default value:None
Description:
The name of the misfit configuration for deleting gradients.
Optional
wavefield_compression
Type:WavefieldCompression | None
Default value:None
Description:
The wavefield compression settings for deleting gradients.
Optional
gradient_parameters
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.
Optional
verbosity
Type:int
Default value:1
Description:
Verbosity level.
SimulationComponent.get_adjoint_input_files()
Create Salvus input files for adjoint simulations for one or more events.
This is largely useful for custom workflows - if you want to simulate and remain fully inside SalvusProject, please use the .launch_adjoint() method.
Returns a tuple of the list of input files and the list of events for the input files. If skip_existing_simulations is True that list might be a subset of the input list.
SIGNATURE
def get_adjoint_input_files(
    self,
    simulation_configuration: str,
    misfit_configuration: str | MisfitConfiguration,
    wavefield_compression: WavefieldCompression,
    gradient_parameters: set[str] | None,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
    ),
    skip_existing_simulations: bool = False,
    verbose: bool = True,
    site_name: str | None = None,
    ranks_per_job: salvus._core.types.int_ | None = None,
) -> tuple[
    list[simple_config.simulation.Waveform], list[Event], dict[str, str]
]: ...
ARGUMENTS
Required
simulation_configuration
Type:str
Description:
Name of the simulation configuration for the forward run.
Required
misfit_configuration
Type:str | MisfitConfiguration
Description:
Name of the misfit configuration.
Required
wavefield_compression
Type:WavefieldCompression
Description:
The wavefield compression settings. Used to check compatibility of potentially already existing checkpoints.
Required
gradient_parameters
Type:set[str] | 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.
Required
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection
Description:
One or more events.
Optional
skip_existing_simulations
Type:bool
Default value:False
Description:
If True, do not return input files for simulations that already exist as part of the project.
Optional
verbose
Type:bool
Default value:True
Description:
Verbosity.
Optional
site_name
Type:str | None
Default value:None
Description:
Optionally provide site name to check for remote files.
Optional
ranks_per_job
Type:salvus._core.types.int_ | None
Default value:None
Description:
Optionally provide the number of ranks to check for consistent checkpoints.
SimulationComponent.get_input_files()
Create Salvus input files for one or more events.
This is largely useful for custom workflows - if you want to simulate and remain fully inside SalvusProject, please use the .launch() method.
Returns a tuple of the list of input files and the list of events for the input files. If skip_existing_simulations is True that list might be a subset of the input list.
SIGNATURE
def get_input_files(
    self,
    simulation_configuration: str | _SimulationConfigurationBase,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
    ),
    skip_existing_simulations: bool = False,
    derived_job_config: WavefieldCompression | None = None,
    verbose: bool = True,
    site_name: str | None = None,
    ranks_per_job: salvus._core.types.int_ | None = None,
    extra_output_configuration: dict[str, typing.Any] | None = None,
    delete_conflicting_previous_results: bool = False,
    allow_empty_output: bool = False,
) -> tuple[
    list[simple_config.simulation.Waveform], list[Event], dict[str, str]
]: ...
ARGUMENTS
Required
simulation_configuration
Type:str | _SimulationConfigurationBase
Description:
Name of the simulation configuration.
Required
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection
Description:
One or more events. If not given, it will return a generic input file without any sources or receivers.
Optional
skip_existing_simulations
Type:bool
Default value:False
Description:
If True, do not return input files for simulations that already exist as part of the project.
Optional
derived_job_config
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. Must be given for checkpoints to be generated during the forward simulation.
Optional
verbose
Type:bool
Default value:True
Description:
Verbosity.
Optional
site_name
Type:str | None
Default value:None
Description:
Optionally provide site name to check for remote files.
Optional
ranks_per_job
Type:salvus._core.types.int_ | None
Default value:None
Description:
Optionally provide the number of ranks to check for consistent checkpoints.
Optional
extra_output_configuration
Type:dict[str, typing.Any] | None
Default value:None
Description:
Extra settings for the waveform simulations. Can only be used for settings that do not change the resulting waveforms. python extra_output_configuration={ "volume_data": { "sampling_interval_in_time_steps": 50, "fields": ["displacement"], }, "surface_data": { "sampling_interval_in_time_steps": 20, "fields": ["acceleration", "velocity"], "side_sets": ["x0", "x1"], }, "memory_per_rank_in_MB": 2000.0, }
Optional
delete_conflicting_previous_results
Type:bool
Default value:False
Description:
If skip_existing_simulations is True, simulations with existing results but different extra_output_configurations would cause an error. If this options is set to True, it will delete the potentially conflicting existing results.
Optional
allow_empty_output
Type:bool
Default value:False
Description:
By default, this method will raise a ValueError if one attempts to get an input file for an event that would have no output at all. This argument overwrites that which is useful for example for visualization purposes.
SimulationComponent.get_mesh()
Load the chosen mesh from disc or create if necessary.
SIGNATURE
def get_mesh(
    self,
    simulation_configuration: str,
    event: Event | str | None = None,
    verbosity: int = 1,
    execution_policy: bindings.ExecutionPolicy = salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy,
    skip_validation: bool = True,
    comm: int | None = None,
) -> UnstructuredMesh | DistributedMesh: ...
ARGUMENTS
Required
simulation_configuration
Type:str
Description:
Simulation for which to get the mesh.
Optional
event
Type:Event | str | None
Default value:None
Description:
Optional event to retrieve an event-dependent mesh. If not given, the master mesh is returned.
Optional
verbosity
Type:int
Default value:1
Description:
Verbosity level.
Optional
execution_policy
Type:bindings.ExecutionPolicy
Default value:<salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy object at 0x7c0325e38ab0>
Description:
Execution policy governing the maximum allowable parallelism of child routines.
Optional
skip_validation
Type:bool
Default value:True
Description:
Whether to skip mesh quality control after mesh creation. Will only trigger if the mesh has not been created yet.
Optional
comm
Type:int | None
Default value:None
Description:
MPI communicator for distributed mesh loading.
SimulationComponent.get_mesh_filenames()
Get mesh and XDMF filenames for a chosen simulation.
This will create the mesh if it does not exist yet, for now in legacy mode (i.e. as an UnstructuredMesh object).
The XDMF file will not exist for the minimal and minimal_fast mesh file modes.
SIGNATURE
def get_mesh_filenames(
    self,
    simulation_configuration: str,
    event: Event | str | None = None,
    verbosity: int = 1,
    execution_policy: bindings.ExecutionPolicy = salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy,
    skip_validation: bool = True,
) -> dict[str, pathlib.Path]: ...
ARGUMENTS
Required
simulation_configuration
Type:str
Description:
Simulation for which to create the mesh.
Optional
event
Type:Event | str | None
Default value:None
Description:
Not active yet but serves as scaffolding for the future possibility to build event dependent meshes.
Optional
verbosity
Type:int
Default value:1
Description:
Verbosity level.
Optional
execution_policy
Type:bindings.ExecutionPolicy
Default value:<salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy object at 0x7c0325e38530>
Description:
Execution policy governing the maximum allowable parallelism of child routines.
Optional
skip_validation
Type:bool
Default value:True
Description:
Whether to skip mesh quality control after mesh creation. Will only trigger if the mesh has not been created yet.
SimulationComponent.get_remote_output_directory()
Get the remote output directory for a given simulation. The function does not check if the remote data still exist.
SIGNATURE
def get_remote_output_directory(
    self, simulation_configuration: str, event: str | Event
) -> dict[str, typing.Any]: ...
ARGUMENTS
Required
simulation_configuration
Type:str
Description:
The name of the simulation configuration.
Required
event
Type:str | Event
Description:
The used event.
SimulationComponent.get_simulation_output_directories()
Get the output directories for a given simulation and a list of events.
SIGNATURE
def get_simulation_output_directories(
    self,
    simulation_configuration: str | _SimulationConfigurationBase,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
    ),
) -> dict[str, pathlib.Path]: ...
ARGUMENTS
Required
simulation_configuration
Type:str | _SimulationConfigurationBase
Description:
The name of the simulation configuration.
Required
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection
Description:
One or several events.
SimulationComponent.get_simulation_output_directory()
Get the output directory for a given simulation.
SIGNATURE
def get_simulation_output_directory(
    self,
    simulation_configuration: str | _SimulationConfigurationBase,
    event: str | Event,
) -> pathlib.Path: ...
ARGUMENTS
Required
simulation_configuration
Type:str | _SimulationConfigurationBase
Description:
The name of the simulation configuration.
Required
event
Type:str | Event
Description:
The used event.
SimulationComponent.get_simulation_template()
Get the Salvus simulation template for a given setup.
SIGNATURE
def get_simulation_template(
    self,
    simulation_configuration: str | _SimulationConfigurationBase,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
        | None
    ) = None,
    extra_output_configuration: dict[str, typing.Any] | None = None,
    apply_waveform_simulation_configuration: bool = True,
    execution_policy: bindings.ExecutionPolicy = salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy,
) -> simple_config.simulation.Waveform: ...
ARGUMENTS
Required
simulation_configuration
Type:str | _SimulationConfigurationBase
Description:
Simulation configuration, or name thereof.
Optional
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection | None
Default value:None
Description:
Optionally pass a list of event to check for consistency regarding attenuation.
Optional
extra_output_configuration
Type:dict[str, typing.Any] | None
Default value:None
Description:
Extra settings for the waveform simulations. Can only be used for settings that do not change the resulting waveforms. python extra_output_configuration={ "volume_data": { "sampling_interval_in_time_steps": 50, "fields": ["displacement"], }, "surface_data": { "sampling_interval_in_time_steps": 20, "fields": ["acceleration", "velocity"], "side_sets": ["x0", "x1"], }, "memory_per_rank_in_MB": 2000.0, }
Optional
apply_waveform_simulation_configuration
Type:bool
Default value:True
Description:
Apply the waveform simulation configuration before returning the template. A ValueError will be raised in case the waveform simulation configuration is event-dependent.
Optional
execution_policy
Type:bindings.ExecutionPolicy
Default value:<salvus._core.lib.salvus_core_python_bindings.ExecutionPolicy object at 0x7c0325e384f0>
Description:
Execution policy governing the maximum allowable parallelism of child routines.
SimulationComponent.launch()
Generate synthetics for one or more events.
SIGNATURE
def launch(
    self,
    simulation_configuration: str,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
    ),
    site_name: str,
    ranks_per_job: salvus._core.types.int_,
    wall_time_in_seconds_per_job: salvus._core.types.float_ | None = None,
    derived_job_config: WavefieldCompression | None = None,
    store_adjoint_checkpoints: bool | None = None,
    verbosity: salvus._core.types.int_ = 2,
    max_block_in_seconds: salvus._core.types.float_ = 0,
    extra_output_configuration: dict[str, typing.Any] | None = None,
    delete_conflicting_previous_results: bool = False,
) -> int: ...
ARGUMENTS
Required
simulation_configuration
Type:str
Description:
Name of the simulation configuration.
Required
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection
Description:
One or more events.
Required
site_name
Type:str
Description:
Site to use.
Required
ranks_per_job
Type:salvus._core.types.int_
Description:
Ranks per job.
Optional
wall_time_in_seconds_per_job
Type:salvus._core.types.float_ | None
Default value:None
Description:
Wall time per job.
Optional
derived_job_config
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.
Optional
store_adjoint_checkpoints
Type:bool | None
Default value:None
Description:
Deprecated. Please use the derived_job_config parameter.
Optional
verbosity
Type:salvus._core.types.int_
Default value:2
Description:
Verbosity.
Optional
max_block_in_seconds
Type:salvus._core.types.float_
Default value:0
Description:
If set, the function will wait for the specified time for the simulations to finish.
Optional
extra_output_configuration
Type:dict[str, typing.Any] | None
Default value:None
Description:
Extra settings for the waveform simulations. Can only be used for settings that do not change the resulting waveforms. python extra_output_configuration={ "volume_data": { "sampling_interval_in_time_steps": 50, "fields": ["displacement"], }, "surface_data": { "sampling_interval_in_time_steps": 20, "fields": ["acceleration", "velocity"], "side_sets": ["x0", "x1"], }, "memory_per_rank_in_MB": 2000.0, }
Optional
delete_conflicting_previous_results
Type:bool
Default value:False
Description:
If data for an event but a different extra_output_configuration already exists, an error will be raised. If this option is set to True, it will delete pre-existing conflicting output. Use with caution, as this can delete expensive-to-compute outputs.
SimulationComponent.launch_adjoint()
Launch adjoint simulations for one or more events.
SIGNATURE
def launch_adjoint(
    self,
    simulation_configuration: str,
    misfit_configuration: str,
    wavefield_compression: WavefieldCompression,
    gradient_parameters: set[str] | None,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
    ),
    site_name: str,
    ranks_per_job: int,
    wall_time_in_seconds_per_job: salvus._core.types.float_ | None = None,
    verbosity: bool = True,
    max_block_in_seconds: int = 0,
) -> int: ...
ARGUMENTS
Required
simulation_configuration
Type:str
Description:
Name of the simulation configuration for the forward run.
Required
misfit_configuration
Type:str
Description:
Name of the misfit configuration.
Required
wavefield_compression
Type:WavefieldCompression
Description:
The gradient compression settings.
Required
gradient_parameters
Type:set[str] | 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.
Required
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection
Description:
One or more events.
Required
site_name
Type:str
Description:
Site to use.
Required
ranks_per_job
Type:int
Description:
Ranks per job.
Optional
wall_time_in_seconds_per_job
Type:salvus._core.types.float_ | None
Default value:None
Description:
Wall time per job.
Optional
verbosity
Type:bool
Default value:True
Description:
Verbosity.
Optional
max_block_in_seconds
Type:int
Default value:0
Description:
If set, the function will wait for the specified time for the simulations to finish.
SimulationComponent.list()
Get a list of all simulation configurations.
SIGNATURE
def list(self) -> list[str]: ...
SimulationComponent.list_events()
Return all event names known for this simulation configuration.
SIGNATURE
def list_events(
    self, simulation_configuration: str, verbosity: int = 1
) -> dict[str, typing.Any]: ...
ARGUMENTS
Required
simulation_configuration
Type:str
Description:
Name of the simulation configuration.
Optional
verbosity
Type:int
Default value:1
Description:
Verbosity level.
SimulationComponent.query()
Query the status of currently ongoing simulations.
SIGNATURE
def query(
    self,
    simulation_configuration: str | None = None,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
        | None
    ) = None,
    misfit_configuration: str | MisfitConfiguration | None = None,
    wavefield_compression: WavefieldCompression | None = None,
    gradient_parameters: set[str] | None = None,
    get_all_outputs: bool | None = None,
    block: bool = False,
    ping_interval_in_seconds: salvus._core.types.float_ | None = None,
    raise_on_failed_jobs: bool = True,
    verbosity: int = 1,
) -> bool: ...
ARGUMENTS
Optional
simulation_configuration
Type:str | None
Default value:None
Description:
Name of the simulation configuration.
Optional
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection | None
Default value:None
Description:
One or more events.
Optional
misfit_configuration
Type:str | MisfitConfiguration | None
Default value:None
Description:
Optional misfit configuration to query adjoint simulations
Optional
wavefield_compression
Type:WavefieldCompression | None
Default value:None
Description:
Must be given for querying adjoint simulations.
Optional
gradient_parameters
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.
Optional
get_all_outputs
Type:bool | None
Default value:None
Description:
Optional flag to skip the download of large output files. If not set, checkpoints will remain on the remote site, while all other outputs are downloaded. If False, the data can manually be downloaded using EventData.download_extra_outputs().
Optional
block
Type:bool
Default value:False
Description:
If True, wait for all simulations to finish.
Optional
ping_interval_in_seconds
Type:salvus._core.types.float_ | None
Default value:None
Description:
Update interval of the status of the jobs if block=True.
Optional
raise_on_failed_jobs
Type:bool
Default value:True
Description:
If True, querying failed or cancelled jobs will raise an error. When set to false, errors for the failed jobs will be retrieved and printed in the in the widget, but no error will be thrown.
Optional
verbosity
Type:int
Default value:1
Description:
Verbosity level. Negative values hide the widget.
SimulationComponent.run()
Run simulations for a selection of events, wait for them to finish, and add the results to the project.
This function only returns after all simulations have been completed. For an asynchronous options, use launch() instead.
SIGNATURE
def run(
    self,
    simulation_configuration: str,
    events: (
        str
        | typing.Sequence[str]
        | Event
        | typing.Sequence[Event]
        | EventCollection
    ),
    site_config: (
        SiteConfig
        | TaskChainSiteConfig
        | dict[str, TaskChainSiteConfig]
        | MPIExecutionConfiguration
    ),
    timer: Timer | None = None,
) -> None: ...
ARGUMENTS
Required
simulation_configuration
Type:str
Description:
Name of the simulation configuration.
Required
events
Type:str | typing.Sequence[str] | Event | typing.Sequence[Event] | EventCollection
Description:
One or more events.
Required
site_config
Type:SiteConfig | TaskChainSiteConfig | dict[str, TaskChainSiteConfig] | MPIExecutionConfiguration
Description:
The site configuration and job submission settings.
Optional
timer
Type:Timer | None
Default value:None
Description:
Execution timer.
Previous
misfit_component
Next
types
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