run_incremental_normal_depth#

URL: /processes/run_incremental_normal_depth/execution

Method: POST

Description:

ripple1d.ops.ras_run.run_incremental_normal_depth(submodel_directory, plan_suffix, ras_version='631', depth_increment=0.5, write_depth_grids=True, show_ras=False)

Write and compute incremental normal depth runs to develop rating curves and depth grids.

Parameters:

  • submodel_directory (str) – The path to the directory containing a sub model geopackage

  • plan_suffix (str) – characters to append to the end of the plan name, by default “_nd”

  • ras_version (str, optional) – which version of HEC-RAS to use, by default “631”

  • depth_increment (float, optional) – stage increment to use for developing the stage-discharge rating curve, by default 0.5

  • write_depth_grids (str, optional) – whether to generate depth rasters after each model run, by default True

  • show_ras (bool, optional) – whether to run HEC-RAS headless or not, by default False

  • task_id (str, optional) – Task ID to use for logging, by default “”

Returns:

string representation of flow file data

Return type:

str

Raises:

FileNotFoundError – raised when .conflation.json file not found in submodel_directory

Notes

run_incremental_normal_depth is intended to resample a stage-discharge rating curve generated with create_model_run_normal_depth to a consistent stage increment. Min and max stages for the curve are taken from the sub model plan with suffix “_ind”. A set of evenly spaced stages are selected between the min and max, and discharge values are estimated with linear interpolation. The final set of estimated discharges are then run through the model with a normal depth downstream boundary condition with slope of 0.001.