src.dynamic_boundary_conditions.river.river_model_input

This script handles the task of generating the requested river model inputs for BG-Flood.

Attributes

log

Functions

generate_river_model_input(→ None)

Generate the requested river model inputs for BG-Flood.

Module Contents

src.dynamic_boundary_conditions.river.river_model_input.log
src.dynamic_boundary_conditions.river.river_model_input.generate_river_model_input(bg_flood_dir: pathlib.Path, hydrograph_data: geopandas.GeoDataFrame) → None

Generate the requested river model inputs for BG-Flood.

Parameters:

  • bg_flood_dir (pathlib.Path) – The BG-Flood model directory.

  • hydrograph_data (gpd.GeoDataFrame) – A GeoDataFrame containing hydrograph data for the requested REC river inflow scenario.

Returns:

This function does not return any value.

Return type:

None