hydroflows.methods.rainfall.pluvial_design_events_GPEX#
Method for generating pluvial design events based on the GPEX global IDF dataset.
- class hydroflows.methods.rainfall.pluvial_design_events_GPEX.PluvialDesignEventsGPEX(gpex_nc: Path, region: Path, event_root: Path = PosixPath('data/events/rainfall'), rps: list[int] | None = None, duration: int = 48, event_names: list[str] | None = None, wildcard: str = 'event', **params)[source]#
Method for generating pluvial design events based on the GPEX global IDF dataset using the alternating block method.
- Parameters:
gpex_nc (Path) – The file path to the GPEX data set.
region (Path) – The file path to the geometry file for which we want to derive GPEX estimates at its centroid pixel.
event_root (Path, optional) – The root folder to save the derived design events, by default “data/events/rainfall”.
rps (List[float], optional) – Return periods of design events, by default [2, 5, 10, 20, 39, 50, 100].
duration (int) – Duration of the produced design event, by default 48 hours.
event_names (List[str], optional) – List of event names for the design events, by “p_event{i}”, where i is the event number.
wildcard (str, optional) – The wildcard key for expansion over the design events, by default “event”.
**params – Additional parameters to pass to the PluvialDesignEventsGPEX Params instance.
See also
PluvialDesignEventsGPEX InputPluvialDesignEventsGPEX OutputPluvialDesignEventsGPEX ParamsCreate a new expand method instance.
- pydantic model hydroflows.methods.rainfall.pluvial_design_events_GPEX.Input[source]#
Input parameters for
PluvialDesignEventsGPEXmethod.Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- pydantic model hydroflows.methods.rainfall.pluvial_design_events_GPEX.Output[source]#
Output parameters for
PluvialDesignEventsGPEX.Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- field event_set_yaml: Annotated[Path, AfterValidator(func=filedir_validator)] [Required]#
The path to the event set yml file, see also
hydroflows.methods.events.EventSet.
- field event_yaml: Annotated[Path, AfterValidator(func=filedir_validator)] [Required]#
The path to the event description file, see also
hydroflows.methods.events.Event.
- pydantic model hydroflows.methods.rainfall.pluvial_design_events_GPEX.Params[source]#
Parameters for
PluvialDesignEventsGPEXmethod.Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- Fields:
- field eva_method: Literal['gev', 'gumbel', 'mev', 'pot'] = 'gev'#
Extreme value distribution method to get the GPEX estimate. Valid options within the GPEX dataset are “gev” for the Generalized Extreme Value ditribution, “mev” for the Metastatistical Extreme Value distribution, and “pot” for the Peak-Over-Threshold distribution.
- field event_names: <lambda>, json_schema_input_type=PydanticUndefined)] | None = None#
List of event names associated with return periods.
- field event_root: Annotated[Path, AfterValidator(func=outputdirpath_validator)] [Required]#
Root folder to save the derived design events.
- field plot_fig: bool = True#
Determines whether to plot figures, including the derived design hyetographs as well as the calculated IDF curves per return period.
- field rps: <lambda>, json_schema_input_type=PydanticUndefined)] [Required]#
Return periods of interest.