hydromt_wflow.workflows.reservoir_id_maps#

hydromt_wflow.workflows.reservoir_id_maps(gdf: GeoDataFrame, ds_like: Dataset, min_area: float = 0.0, uparea_name: str = 'uparea') tuple[Dataset | None, GeoDataFrame | None][source]#

Return reservoir location maps (see list below).

At model resolution based on gridded upstream area data input or outlet coordinates.

The following reservoir maps are calculated:

  • reservoir_area_id : reservoir areas mask [ID]

  • reservoir_outlet_id : reservoir outlets [ID]

Parameters:
  • gdf (geopandas.GeoDataFrame) – GeoDataFrame containing reservoirs/lakes geometries and attributes.

  • ds_like (xarray.DataArray) – Dataset at model resolution.

  • min_area (float, optional) – Minimum reservoir area threshold [km2], by default 0.0 km2.

  • uparea_name (str, optional) – Name of uparea variable in ds_like. If None then database coordinates will be used to setup outlets

Returns:

  • ds_out (xarray.DataArray) – Dataset containing gridded reservoir data

  • gdf (geopandas.GeoDataFrame) – GeoDataFrame containing (updated) reservoir outlet coordinates.