Configuration Files#

Configuration File WHM#

File Path#

Users can change the path to the climate forcings, water use data and static land data required by WaterAP in NetCDF format in the “inputDir” (see image below). The path to the output data can be changed in the “outputDir”.

../_images/file_path.png

Note

The climate forcing directory should follow the folder structure as described in the five minute guide.

Runtime Options#

Simulation Options#

../_images/runtime_options_standard_run.png

“AntNat_opts”: {“ant”: true, “subtract_use”: true, “res_opt”: true} as shown in the image above, simulates the effects of both human water use and man-made reservoirs (including their commissioning years) on flows and storages and is referred to as a standard anthropogenic run.

The following options in „AntNat_opts“ can be turned off and on to simulate:

  1. a naturalized run (without human impact). For a tutorial on how to simulate a naturalized run, see here.

../_images/runtime_options_naturalized_run.png

  1. human water use only (simulation excludes reservoir impact). For a tutorial on how to run WaterGAP simulation with human water use only, see here.

../_images/runtime_options_use_only_run.png

  1. reservoirs only (simulation excludes human water use). For a tutorial on how to run WaterGAP simulation with reservoirs only, see here.

../_images/runtime_options_reservoirs_only_run.png
WaterGap satisfies surface water demand spatially using:

  • riparian water supply option which by default is always enabled and can not be disabled.

  • neighboring cell water supply option

and temporally using :

  • delayed water supply option

The neighboring cell and delayed use water supply option can either or both be activated (set to “true”) or deactivated (set to “false”) in the “Demand_satisfaction_opts” as shown in the image below:

../_images/runtime_options_demand_satisfaction_options.png

For more details on these water satisfaction options read net abstractions.

Restart Options#

../_images/restart_options.png

Setting “restart” to “true” will prompt WaterGAP to restart from a previously saved state. To create a saved state, the “save_model_states_for_restart” option must be set to “true”. The directory to save saved states (storages, fluxes, etc.) can be defined in the “save_and_read_states_dir” option.

For a tutorial on how to restart WaterGAP from a saved state, see here.

Simulation Period#

Users can change the start and end dates of the simulation, the start and end operational years for reservoirs, as well as model spinup years (see image below).

../_images/simulation_period.png

Time Step#

../_images/time_step.png

At the moment WaterGAP simulations only use daily temporal resolution. Always leave it set to “true”.

Simulation Extent#

../_images/simulation_extent.png

Setting the “run_basin” to “true” will prompt WaterGAP to run for a particular basin. By chosing a downstream grid cell, WaterGAP defines a corresponding upstream basin. To define the downstream grid cell the location of the grid cell (in degree latitude and longitude) defined in a station.csv file. The path to such file is passsed to WaterGAP using the “path_to_stations_file” (see image). An example file (stations.csv) can be found in the static_input folder [HydrologyFrankfurt/ReWaterGAP].

For a tutorial on how to run WaterGAP for a particular basin, see here.

Output Variables#

../_images/output_variables.png

A comprehensive list of the output variables in the image above can be found in the glossary. Each output can be toggled on (set to “true”) or off (set to “false”) in the “OutputVariable” options.

Configuration File GWSWUSE#

File Path#

  • input_data: Path to the folder containing input data. This folder must have a specific structure for the data to be correctly matched and processed.

  • gwswuse_convention: Path to the convention file that defines the conventions for data verification and processing.

  • outputDir: Path to the folder where output data will be stored.

../_images/file_path1.png

Runtime Options#

../_images/runtime_options.png

Simulation Options#

  • time_extend_mode: Controls how time-dependent input data is handled to ensure they cover the entire simulation period.

  • irrigation_efficiency_gw_mode: Determines how irrigation efficiency with groundwater is calculated.

  • irrigation_input_based_on_aei: Specifies how input data for irrigation-specific consumptive water use is interpreted.

  • correct_irr_simulation_by_t_aai: Indicates whether the simulation should adjust for temporal changes in irrigated areas.

  • deficit_irrigation_mode: Determines whether the simulation considers deficit irrigation in certain grid cells.

Parameter Setting#

  • efficiency_gw_threshold: Threshold for irrigation efficiency with groundwater.

  • deficit_irrigation_factor: Reduction factor for irrigation in grid cells identified as deficient.

Simulation Period#

CellSpecific Output#

  • flag: If true, sector-specific intermediate results for the grid cell closest to the coordinates in CellSpecificOutput[“coords”] will be displayed in the CLI during the simulation.

  • coords: A sub-dict for setting coordinates for the grid cell and timestep for displaying cell-specific results in the CLI:

  • Lat: Latitude of the grid cell

  • Lon: Longitude of the grid cell

  • Year: Year

  • Month: Month (for irrigation and total)

Output Variables#

../_images/output_selection.png

Determines which simulation results are saved and in what format they are output.

  • WGHM_input_run: Controls whether the results are retained in memory for further use in a ReWGHM run.

  • Sectors: Selection of sectors for which simulation results should be saved (e.g., irrigation, households, etc.).

  • GWSWUSE variables: Defines which specific variables (e.g., consumptive_use, abstraction, return_flow, net_abstraction) for each water source (groundwater or surface water) should be saved.

  • Global_Annual_Totals: Controls whether ReGWSWUSE generates a comprehensive overview of simulation results in an Excel file with global annual values.