Water demand

.gitignore

@@ -91,6 +91,7 @@ examples/wflow_test_clip
 examples/wflow_piave_corine
 examples/wflow_piave_forcing
 examples/wflow_piave_gauges
+examples/wflow_piave_water_demand
 examples/wflow_test_sediment
 examples/wflow_test_extend_sediment
 examples/hydro_data

docs/api.rst

@@ -35,8 +35,14 @@ Setup components
    WflowModel.setup_reservoirs
    WflowModel.setup_glaciers
    WflowModel.setup_lulcmaps
+   WflowModel.setup_lulcmaps_with_paddy
    WflowModel.setup_laimaps
    WflowModel.setup_laimaps_from_lulc_mapping
+   WflowModel.setup_allocation_areas
+   WflowModel.setup_surfacewaterfrac
+   WflowModel.setup_domestic_demand
+   WflowModel.setup_other_demand
+   WflowModel.setup_irrigation
    WflowModel.setup_ksathorfrac
    WflowModel.setup_rootzoneclim
    WflowModel.setup_soilmaps
@@ -241,6 +247,9 @@ Wflow workflows
 .. autosummary::
    :toctree: _generated
 
+   workflows.allocation_areas
+   workflows.surfacewaterfrac
+   workflows.non_irrigation
    workflows.hydrography
    workflows.topography
    workflows.river

docs/changelog.rst

@@ -54,17 +54,19 @@ Added
 - If applicable, basins geometry based on the higher resolution DEM is stored seperately under **basins_highres** `PR #266 <https://github.com/Deltares/hydromt_wflow/pull/266>`_
 - New function **setup_1dmodel_connection** to connect wflow to 1D river model (eg Delft3D FM 1D, HEC-RAS, etc.) `PR #210 <https://github.com/Deltares/hydromt_wflow/pull/210>`_
 - New setup method for the **KsatHorFrac** parameter **setup_ksathorfarc** to up-downscale existing ksathorfrac maps. `PR #255 <https://github.com/Deltares/hydromt_wflow/pull/255>`_
-- new function **setup_pet_forcing** to reproject existing pet data rather than computing from other meteo data. PR #257
+- New function **setup_pet_forcing** to reproject existing pet data rather than computing from other meteo data. PR #257
 - Workflow to compute brooks corey c for the wflow layers based on soilgrids data, soilgrids_brooks_corey. PR #242
+- Better support for WflowModel states with new methods: **read_states**, **write_states** and **clip_states**. PR #252
 - **setup_lulcmaps** for wflow_sediment: if planted forest data is available, it can be used to update the values of the USLE C parameter. PR #234
-- better support for WflowModel states with new methods: **read_states**, **write_states** and **clip_states**. PR #252
-- new function **setup_cold_states** to prepare cold states for WflowModel. PR #252
-- new utils method **get_grid_from_config** to get the right wflow staticmaps variable based on the TOML configuration (e.g. detects name in netcdf, value, scale and offset). Only applied now to prepare cold states (e.g. not yet in read_grid). PR #252
+- New function **setup_cold_states** to prepare cold states for WflowModel. PR #252
+- New utils method **get_grid_from_config** to get the right wflow staticmaps variable based on the TOML configuration (e.g. detects name in netcdf, value, scale and offset). Only applied now to prepare cold states (e.g. not yet in read_grid). PR #252
+- New functions (properly) for setting up water demand: **setup_allocation_areas**, **setup_surfacewaterfrac**, **setup_non_irrigation** and **setup_irrigation**. `PR #226 <https://github.com/Deltares/hydromt_wflow/pull/226>`
 - Added support for the "GLCNMO" land-use dataset, with a default parameter mapping table (similar to the existing tables). PR #272
 - Added the `alpha_h1` parameter (based on land use maps). This parameter represents whether root water uptake reduction at soil water pressure head h1 occurs or not. By default, it is set  to 0.0 for all "non-natural" vegetation (crops) and to 1.0 for all "natural vegetation" PR #272
 - Parameter for output filename in **write_grid** (`fn_out`). PR #278
 - New function **setup_laimaps_from_lulc_mapping** to set leaf area index (LAI) climatology maps per month based on landuse mapping. PR #273
 
+
 Changed
 -------
 - Basins geometry (**basins**) is now based on the actual wflow model resolution basins, instead of based on the supplied DEM `PR #266 <https://github.com/Deltares/hydromt_wflow/pull/266>`

docs/user_guide/wflow_model_setup.rst

@@ -47,7 +47,9 @@ a specific method see its documentation.
     * - :py:func:`~WflowModel.setup_glaciers`
       - This component generates maps of glacier areas, area fraction and volume fraction, as well as tables with temperature threshold, melting factor and snow-to-ice conversion fraction.
     * - :py:func:`~WflowModel.setup_lulcmaps`
-      - This component derives several wflow maps are derived based on landuse- landcover (LULC) data.
+      - This component derives several wflow maps based on landuse- landcover (LULC) data.
+    * - :py:func:`~WflowModel.setup_lulcmaps_with_paddy`
+      - This component derives several wflow maps based on landuse- landcover (LULC) data with paddy rice.
     * - :py:func:`~WflowModel.setup_laimaps`
       - This component sets leaf area index (LAI) climatology maps per month.
     * - :py:func:`~WflowModel.setup_laimaps_from_lulc_mapping`
@@ -74,6 +76,16 @@ a specific method see its documentation.
       -  Setup gridded reference evapotranspiration forcing at model resolution.
     * - :py:func:`~WflowModel.setup_constant_pars`
       -  Setup constant parameter maps for all active model cells.
+    * - :py:func:`~WflowModel.setup_allocation_areas`
+      -  Create water demand allocation areas.
+    * - :py:func:`~WflowModel.setup_surfacewaterfrac`
+      -  Create water demand surface water consumption fraction.
+    * - :py:func:`~WflowModel.setup_domestic_demand`
+      -  Create domestic water demand.
+    * - :py:func:`~WflowModel.setup_other_demand`
+      -  Create other water demand (eg industry, livestock).
+    * - :py:func:`~WflowModel.setup_irrigation`
+      -  Create irrigation areas and trigger for paddy and nonpaddy crops.
     * - :py:func:`~WflowModel.setup_1dmodel_connection`
       -  Setup subbasins and gauges to save results from wflow to be used in 1D river models.
     * - :py:func:`~WflowModel.setup_grid_from_raster`

docs/user_guide/wflow_update.rst

@@ -36,4 +36,5 @@ To add or change one or more components of an existing Wflow model the ``update`
     Example: Update Wflow model (landuse) <../_examples/update_model_landuse.ipynb>
     Example: Update Wflow model (forcing) <../_examples/update_model_forcing.ipynb>
     Example: Update Wflow model (gauges) <../_examples/update_model_gauges.ipynb>
+    Example: Update Wflow model with water demand <../_examples/update_model_water_demand.ipynb>
     Example: Connect Wflow to a 1D river model <../_examples/connect_to_1d_model.ipynb>