hydromt_wflow.workflows.river#

hydromt_wflow.workflows.river(ds, ds_model=None, river_upa=30.0, slope_len=2000.0, min_rivlen_ratio=0.0, channel_dir='up', logger=<Logger hydromt_wflow.workflows.river (WARNING)>)[source]#

Return river maps.

The output maps are:

  • rivmsk : river mask based on upstream area threshold on upstream area

  • rivlen : river length [m]

  • rivslp : smoothed river slope [m/m]

  • rivzs : elevation of the river bankfull height based on pixel outlet

  • rivwth : river width at pixel outlet (if in ds)

  • qbankfull : bankfull discharge at pixel outlet (if in ds)

Parameters:

  • ds (xr.Dataset) – hydrography dataset containing “flwdir”, “uparea”, “elevtn” variables; and optional “rivwth” and “qbankfull” variable

  • ds_model (xr.Dataset, optional) – model dataset with output grid, must contain “uparea”, for subgrid rivlen/slp must contain “x_out”, “y_out”. If None, ds is assumed to be the model grid

  • river_upa (float) – minimum threshold to define river cell & pixels, by default 30 [km2]

  • slope_len (float) – minimum length over which to calculate the river slope, by default 1000 [m]

  • min_rivlen_ratio (float) – minimum global river length to avg. Cell resolution ratio used as threshold in window based smoothing of river length, by default 0.0. The smoothing is skipped if min_riverlen_ratio = 0.

  • channel_dir ({"up", "down"}) – flow direction in which to calculate (subgrid) river length and width

Returns:

ds_out – Dataset with output river attributes

Return type:

xr.Dataset