Version:

salvus.project.configuration.event_configuration

salvus.project.configuration.event_configuration salvus project configuration event_configuration
Event configuration.

Classes

EventConfiguration

Event specific configuration.
SIGNATURE
class EventConfiguration(
    salvus.flow.utils.serialization_helpers.SerializationMixin
):
    def __init__(
        self,
        wavelet: stf._Base | typing.Sequence[stf._Base],
        waveform_simulation_configuration: WaveformSimulationConfiguration,
    ): ...
ARGUMENTS
Required
wavelet
Type:stf._Base | typing.Sequence[stf._Base]
Description:
Source wavelet.
Required
waveform_simulation_configuration
Type:WaveformSimulationConfiguration
Description:
More specialized configuration of the waveform simulation by being able to directly specify a subset of the actual simulation input files.

Class Methods

EventConfiguration.from_json()
Recreate the object from a dictionary serialization of its initialization parameters.
SIGNATURE
def from_json(d: builtins.dict) -> Any: ...
ARGUMENTS
Required
d
Type:builtins.dict
Description:
Dictionary containing its init parameters and a few other things.

Methods

EventConfiguration.to_json()
Serialize the object to a dictionary that can be written to JSON.
SIGNATURE
def to_json(
    self,
    external_file_hash: types = None,
    timer: types = None,
    log_to_logger: bool = False,
    comm: types = None,
) -> builtins.dict: ...
ARGUMENTS
Optional
external_file_hash
Type:types
Default value:None
Description:
Hash of any external files associated with this object. Can be passed here in which case it will be stored in a centralized location in the JSON file.
Optional
timer
Type:types
Default value:None
Description:
Execution timer.
Optional
log_to_logger
Type:bool
Default value:False
Description:
Log timings to the logger.
Optional
comm
Type:types
Default value:None
Description:
MPI communicator, if any.

Used in tutorials

Functionality from this module is used in the following tutorials.
PAGE CONTENTS