HistoricalEvent

objects.HistoricalEvent()

BaseModel describing the expected variables and data types for parameters of HistoricalEvent that extend the parent class Event.

Attributes

name : str

The name of the event.

description : str

The description of the event. Defaults to ““.

time : TimeFrame

The time frame of the event.

template : Template

The template of the event. Defaults to Template.Historical.

mode : Mode

The mode of the event. Defaults to Mode.single_event.

rainfall_multiplier : float

The rainfall multiplier of the event. Defaults to 1.0.

forcings : dict[ForcingType, list[IForcing]]

The forcings of the event.

Back to top