hydromt_sfincs.components.quadtree.SfincsQuadtreeInfiltration.create_bucket#

SfincsQuadtreeInfiltration.create_bucket(hsg: str | Path | DataArray | Dataset, ksat: str | Path | DataArray | Dataset | None = None, lulc: str | Path | DataArray | Dataset | None = None, reclass_table: str | Path | DataFrame | None = None, lulc_modifier_table: str | Path | DataFrame | None = None, dual_hsg: str = 'drained', bucket_loss: float | None = None, reproj_method: str = 'average') → None[source]#

Estimate bucket infiltration from HSG and optional landuse.

Adds model layers:

  • bucket_smax map: bucket maximum storage [mm]

  • bucket_k map: bucket drainage coefficient [hr-1]

  • bucket_loss map: bucket loss fraction [-]

Parameters:

  • hsg (str, Path, or RasterDataset) – Hydrologic soil group map. By default, values are reclassified with the bundled hsg_bucket.csv table.

  • ksat (str, Path, or RasterDataset, optional) – Saturated hydraulic conductivity map, used to derive bucket_k (via a residence time bucket_smax / ksat, ksat in mm/hr). Required unless the reclass table provides a bucket_k or residence_time_hr column. The bundled hsg_bucket.csv provides neither, so ksat is required when using it; omitting it raises a ValueError. (bucket_smax itself comes from the table and does not need ksat.)

  • lulc (str, Path, or RasterDataset, optional) – Land-use map used to apply infiltration modifiers. Its classes must match the index of lulc_modifier_table.

  • reclass_table (str, Path, or DataFrame, optional) – Table mapping HSG classes to bucket parameters.

  • lulc_modifier_table (str, Path, or DataFrame, optional) – Required with lulc. Table of modifier factors keyed by the land-cover class codes in the supplied dataset.

  • dual_hsg ({'native', 'drained'}, optional) – How to handle dual HSG classes, by default ‘drained’. Native dual classes must be present in the reclassification table.

  • bucket_loss (float, optional) – Uniform bucket loss fraction. Defaults to 0.0 without land use and 0.10 with land-use modifiers.

  • reproj_method (str, optional) – Resampling method for reprojecting final parameter maps to quadtree blocks. By default ‘average’.

On this page