hydromt_wflow.WflowModel.setup_outlets#

WflowModel.setup_outlets(river_only: bool = True, toml_output: str = 'csv', gauge_toml_header: List[str] = ['river_q'], gauge_toml_param: List[str] = ['river_water__volume_flow_rate'])[source]#

Set the default gauge map based on basin outlets.

If the subcatchment map is available, the catchment outlets IDs will be matching the subcatchment IDs. If not, then IDs from 1 to number of outlets are used.

Can also add csv/netcdf_scalar output settings in the TOML.

Adds model layers:

• outlets map: IDs map from catchment outlets [-]

• outlets geom: polygon of catchment outlets

Parameters:

• river_only (bool, optional) – Only derive outlet locations if they are located on a river instead of locations for all catchments, by default True.

• toml_output (str, optional) – One of [‘csv’, ‘netcdf_scalar’, None] to update [output.csv] or [output.netcdf_scalar] section of wflow toml file or do nothing. By default, ‘csv’.

• gauge_toml_header (list, optional) – Save specific model parameters in csv section. This option defines the header of the csv file. By default saves river_q (for river_water__volume_flow_rate).

• gauge_toml_param (list, optional) – Save specific model parameters in csv section. This option defines the wflow variable corresponding to the names in gauge_toml_header. By default saves river_water__volume_flow_rate (for river_q).