Event

objects.Event()

The accepted input for an event in FloodAdapt.

Attributes

name : str

The name of the event.

description : str, default=""

The description of the event.

time : TimeFrame

The time frame of the event.

template : Template

The template of the event.

mode : Mode

The mode of the event.

rainfall_multiplier : float

The rainfall multiplier of the event.

forcings : dict[ForcingType, list[IForcing]]

The forcings of the event.

Methods

Name	Description
get_forcings	Return a list of all forcings in the event.
load_file	Load object from file.
save_additional	Save any additional files associated with the event.

get_forcings

objects.Event.get_forcings()

Return a list of all forcings in the event.

load_file

objects.Event.load_file(file_path: Path | str | os.PathLike)

Load object from file.

Parameters

file_path : Path | str | os.PathLike

Path to the file to load.

save_additional

objects.Event.save_additional(output_dir: Path | str | os.PathLike)

Save any additional files associated with the event.