docs and name function

Deltares · Dec 17, 2024 · c8f9826 · c8f9826
1 parent f588afb
commit c8f9826
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 2 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -263,6 +263,7 @@ Wflow workflows
    workflows.lai_from_lulc_mapping
    workflows.add_paddy_to_landuse
    workflows.ksathorfrac
+   workflows.ksatver_vegetation
    workflows.soilgrids
    workflows.soilgrids_sediment
    workflows.soilgrids_brooks_corey

diff --git a/docs/user_guide/wflow_model_setup.rst b/docs/user_guide/wflow_model_setup.rst
@@ -58,6 +58,8 @@ a specific method see its documentation.
       - This component derives several (layered) soil parameters based on a database with physical soil properties using available point-scale (pedo)transfer functions (PTFs) from literature with upscaling rules to ensure flux matching across scales.
     * - :py:func:`~WflowModel.setup_ksathorfrac`
       - This component prepares ksathorfrac from existing ksathorfrac data.
+    * - :py:func:`~WflowModel.setup_ksatver_vegetation`
+      - This component prepares ksatver from soil and vegetation parameters.
     * - :py:func:`~WflowModel.setup_rootzoneclim`
       - This component derives an estimate of the rooting depth from hydroclimatic data (as an alternative from the look-up table). The method can be applied for current conditions and future climate change conditions.
     * - :py:func:`~WflowModel.setup_outlets`

diff --git a/hydromt_wflow/wflow.py b/hydromt_wflow/wflow.py
@@ -2170,7 +2170,7 @@ def setup_ksatver_vegetation(
         sndppt = dsin["sndppt_sl1"]
 
         # in function get_ksatver_vegetation KsatVer should be provided in mm/d
-        KSatVer_vegetation = workflows.get_ksatver_vegetation(
+        KSatVer_vegetation = workflows.ksatver_vegetation(
             self,
             KsatVer=self.grid["KsatVer"],
             sndppt=sndppt,

diff --git a/hydromt_wflow/workflows/soilparams.py b/hydromt_wflow/workflows/soilparams.py
@@ -195,7 +195,7 @@ def get_ks_veg(KsatVer, sndppt, LAI, alfa=4.5, beta=5):
     return ks
 
 
-def get_ksatver_vegetation(self, KsatVer, sndppt, LAI, alfa=4.5, beta=5):
+def ksatver_vegetation(self, KsatVer, sndppt, LAI, alfa=4.5, beta=5):
     """
     Calculate saturated hydraulic conductivity based on soil and vegetation [mm/d].