hydromt_wflow.workflows.merge_reservoirs#

hydromt_wflow.workflows.merge_reservoirs(ds: Dataset, ds_like: Dataset, duplicate_id: str = 'error') → Dataset | None[source]#

Merge reservoir layers in ds to layers in ds_like.

It will first check if the IDs in ds are not duplicated in ds_like. If they are, the function will raise a warning and return None.

Parameters:

  • ds (xr.Dataset) – Dataset containing the reservoir layers to be merged.

  • ds_like (xr.Dataset) – Dataset containing the reservoir layers to merge into.

  • duplicate_id (str, optional {"error", "skip"}) – Action to take if duplicate reservoir IDs are found when merging with existing reservoirs. Options are “error” to raise an error (default); “skip” to skip adding new reservoirs.

Returns:

Merged dataset of reservoir parameters.

Return type:

xr.Dataset | None