hydromt_wflow.workflows.hydrography#

hydromt_wflow.workflows.hydrography(ds: ~xarray.core.dataset.Dataset, res: float, xy: ~geopandas.geodataframe.GeoDataFrame | None = None, upscale_method: str = 'ihu', flwdir_name: str = 'flwdir', uparea_name: str = 'uparea', basins_name: str = 'basins', strord_name: str = 'strord', ftype: str = 'infer', logger=<Logger hydromt_wflow.workflows.basemaps (WARNING)>)[source]#

Return hydrography maps (see list below) and FlwdirRaster object.

Based on gridded flow direction and elevation data input.

The output maps are:

flwdir : flow direction [-]
basins : basin map [-]
uparea : upstream area [km2]
strord : stream order [-]

If the resolution is lower than the source resolution, the flow direction data is upscaled and river length and slope are based on subgrid flow paths and the following maps are added:

subare : contributing area to each subgrid outlet pixel (unit catchment area) [km2]
subelv : elevation at subgrid outlet pixel [m+REF]

Parameters:

ds (xarray.DataArray) – Dataset containing gridded flow direction and elevation data.
res (float) – output resolution
xy (geopandas.GeoDataFrame, optional) – Subbasin pits. Only required when upscaling a subbasin.
upscale_method ({'ihu', 'eam', 'dmm'}) – Upscaling method for flow direction data, by default ‘ihu’, see [1]
ftype ({'d8', 'ldd', 'nextxy', 'nextidx', 'infer'}, optional) – name of flow direction type, infer from data if ‘infer’, by default is ‘infer’
flwdir_name (str, optional) – Name of flow direction [-], elevation [m], upstream area [km2], basin index [-] and stream order [-] variables in ds
elevtn_name (str, optional) – Name of flow direction [-], elevation [m], upstream area [km2], basin index [-] and stream order [-] variables in ds
uparea_name (str, optional) – Name of flow direction [-], elevation [m], upstream area [km2], basin index [-] and stream order [-] variables in ds
basins_name (str, optional) – Name of flow direction [-], elevation [m], upstream area [km2], basin index [-] and stream order [-] variables in ds
strord_name (str, optional) – Name of flow direction [-], elevation [m], upstream area [km2], basin index [-] and stream order [-] variables in ds

Returns:

ds_out (xarray.DataArray) – Dataset containing gridded hydrography data
flwdir_out (pyflwdir.FlwdirRaster) – Flow direction raster object.

References