hydromt_sfincs.workflows.bucket_from_hsg#

hydromt_sfincs.workflows.bucket_from_hsg(da_hsg: DataArray, df_map: DataFrame, *, da_ksat: DataArray | None = None, bucket_loss: float | None = None, dual_hsg: str = 'drained') → Dataset[source]#

Estimate bucket parameters from HSG classes and optional Ksat.

Storage is derived from storage_depth_mm * effective_fraction when needed. Drainage is derived from Ksat or residence_time_hr if the table does not provide bucket_k. Inputs must already be-read xarray objects and a DataFrame.

Parameters:

  • da_hsg (xr.DataArray) – Hydrologic soil group class raster.

  • df_map (pd.DataFrame) – Bucket parameter table indexed by HSG class.

  • da_ksat (xr.DataArray, optional) – Saturated hydraulic conductivity raster [mm/hr] used to derive bucket_k.

  • bucket_loss (float, optional) – Loss fraction used when the table has no bucket_loss column.

  • dual_hsg ({"drained", "native"}, optional) – HSG normalization mode, by default "drained". Native dual-HSG classes require corresponding rows in df_map.

Returns:

Bucket bucket_smax, bucket_k, and bucket_loss rasters.

Return type:

xr.Dataset

On this page