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

`salvus.project.configuration.event_configuration`

Event configuration.

Classes

`EventConfiguration`

class EventConfiguration(
    salvus.flow.utils.serialization_helpers.SerializationMixin
):
    def __init__(
        self,
        wavelet: stf._Base | typing.Sequence[stf._Base],
        waveform_simulation_configuration: WaveformSimulationConfiguration,
    ): ...

Event specific configuration.

Parameters

wavelet stf._Base | typing.Sequence[stf._Base] — Source wavelet.
waveform_simulation_configuration WaveformSimulationConfiguration — More specialized configuration of the waveform simulation by being able to directly specify a subset of the actual simulation input files.

Methods

`from_json()`

def from_json(d: builtins.dict) -> Any: ...

Recreate the object from a dictionary serialization of its initialization parameters.

Parameters

d builtins.dict — Dictionary containing its init parameters and a few other things.

Returns Any

`to_json()`

def to_json(
    self,
    external_file_hash: types = None,
    timer: types = None,
    log_to_logger: bool = False,
    comm: types = None,
) -> builtins.dict: ...

Serialize the object to a dictionary that can be written to JSON.

Parameters

external_file_hash types — 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.
timer types — Execution timer.
log_to_logger bool — Log timings to the logger.
comm types — MPI communicator, if any.

Returns builtins.dict