hydromt_wflow.workflows.river

hydromt_wflow.workflows.river(ds, ds_like=None, river_upa=30.0, slope_len=1000.0, channel_dir='up', min_rivlen_ratio=0.1, logger=<Logger hydromt_wflow.workflows.river (WARNING)>, **kwargs)[source]

Returns river maps

The output maps are: - rivmsk : river mask based on upstream area threshold on upstream area - rivlen : river length [m], minimum set to 1/4 cell res - rivslp : smoothed river slope [m/m] - rivwth_obs : river width at pixel outlet (if in ds) - rivbed : elevation of the river bed based on pixel outlet

Parameters

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

  • ds_like (xr.Dataset, optional) – dataset with output grid, must contain “uparea”, for subgrid rivlen/slp must contain “x_out”, “y_out”. If None, takes ds grid for output

  • 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, by default 0.1

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

  • Returns –

  • ds_out (xr.Dataset) – Dataset with output river attributes