hydroflows.methods.events.EventSet#
- class hydroflows.methods.events.EventSet(*, root: Path | None = None, events: List[EventDict])[source]#
Bases:
BaseModel
A dictionary of events, referring to event file names.
Examples
The event set can be created from a YAML file as follows:
EventSet.from_yaml("path/to/eventset.yaml")
The event set can be created from a dictionary as follows:
EventSet( events=[ { "name": "event1", "path": "path/to/event1.yml" } ], )
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- field events: List[EventDict] [Required]#
The list of events. Each event is a dictionary with an event name and reference to an event file.