hydromt_wflow.workflows.reservoir_simple_control_parameters#
- hydromt_wflow.workflows.reservoir_simple_control_parameters(gdf: GeoDataFrame, ds_reservoirs: Dataset, timeseries_fn: str = None, output_folder: str | Path | None = None) tuple[Dataset, GeoDataFrame] [source]#
Return reservoir attributes (see list below) needed for modelling.
When specified, some of the reservoir attributes can be derived from earth observation data. Two options are currently available: 1. Global Water Watch data (Deltares, 2022) using gwwapi and 2. JRC (Peker, 2016) using hydroengine.
The following reservoir attributes are calculated:
reservoir_max_volume : reservoir maximum volume [m3]
reservoir_area : reservoir area [m2]
reservoir_initial_depth : reservoir initial water level [m]
reservoir_rating_curve : option to compute rating curve [-]
reservoir_storage_curve : option to compute storage curve [-]
reservoir_demand : reservoir demand flow [m3/s]
reservoir_max_release : reservoir maximum release flow [m3/s]
reservoir_target_full_fraction : reservoir targeted full volume fraction [m3/m3]
reservoir_target_min_fraction : reservoir targeted minimum volume fraction [m3/m3]
Two additional tables will be prepared and saved if output_folder is specified: “reservoir_timeseries_{timeseries_fn}.csv” contains the timeseries downloaded from
timeseries_fn
; “reservoir_accuracy.csv” contains debugging values for reservoir building.- Parameters:
gdf (geopandas.GeoDataFrame) – GeoDataFrame containing reservoirs geometries and attributes.
ds_reservoirs (xarray.Dataset) – Dataset containing reservoir location and outlet id at model resolution.
timeseries_fn (str, optional) – Name of database from which time series of reservoir surface water area will be retrieved. Currently available: [‘jrc’, ‘gww’] Defaults to Deltares’ Global Water Watch database.
output_folder (str or Path, optional) – Folder to save the reservoir time series data and parameter accuracy as .csv files. If None, no file will be saved.
- Returns:
ds_reservoirs (xarray.Dataset) – Dataset containing reservoir locations and parameters at model resolution.
gdf_out (geopandas.GeoDataFrame) – GeoDataFrame containing reservoir parameters.