floodresilience.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

remove_existing_river_inputs(→ None)	Remove existing river input files from the specified directory.
generate_river_model_input(→ None)	Generate the requested river model inputs for BG-Flood.

Module Contents

floodresilience.dynamic_boundary_conditions.river.river_model_input.log

floodresilience.dynamic_boundary_conditions.river.river_model_input.remove_existing_river_inputs(bg_flood_dir: pathlib.Path) → None

Remove existing river input files from the specified directory.

Parameters:

bg_flood_dir (pathlib.Path) – The BG-Flood model directory containing the river input files.

floodresilience.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.