Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.71 KB

README.md

File metadata and controls

56 lines (36 loc) · 2.71 KB
Raw

DOI

WDPM

The Wetland DEM Ponding Model (WDPM) was developed at the Centre for Hydrology at the University of Saskatchewan to model the spatial distribution of water in depressions in the Canadian Prairies.

The program is described in

Shook et al., (2021). WDPM: the Wetland DEM Ponding Model. Journal of Open Source Software, 6(64), 2276, https://doi.org/10.21105/joss.02276

Please cite all uses of the program.

Several presentations on using WDPM are available at https://research-groups.usask.ca/hydrology/modelling/wdpm.php.

Folders and files

/ - contains files describing the program

  • README.md - this file
  • LICENSE - GPL 3.0 licence file
  • requirements.txt - file containing libraries required by WDPM.py
  • codemeta.json - description of the project metadata

src - contains program source code files:

  • WDPMCL.c - WDPM main line. Can be executed from the command line or from the GUI
  • runoff.cl - OpenCL kernel that does the water smoothing
  • WDPM.py - GUI for running the program. Written in Python 3
  • CMakeLists.txt - configuration file for building the program using cmake
  • cmap_black.sh - shell script for converting model output to an image on Linux or MacOS
  • cmap.bat - shell script for converting model output to an image on Windows

dem - contains a sample digital elevation model (DEM) for use with the WDPM:

  • basin5.asc - DEM of sub-basin 5 at Smith Creek in SW Saskatchewan.

paper - contains files for the paper 'WDPM: the Wetland DEM Ponding Model'

manual - contains the user manual WDPMUserGuide_2.pdf as well as the document Lyx file and images used

validation - contains scripts to validate that WDPM is running correctly

  • validate_WDPM.sh - Bash script which runs the other scripts
  • add_test.awk - awk script to test the WDPM Add module
  • drain_test.awk - awk script to test the WDPM Drain module
  • subtract_test.awk - awk script to test the WDPM Subtract module
  • WDPM_validation.md - Markdown document explaining the validation scripts

Program requirements

The WDPM requires the use of other programs in order to work properly.

  • Python 3 and the wxPython library are required to run the GUI,
  • OpenCL drivers are required to use parallel processing,
  • gdaldem is required to create maps of water distribution.

Compilation of the WDPM and installation of the other required software are described in the manual WDPMUserGuide_2.pdf. The manual also describes how to run the program and gives case studies showing how the program has been used to solve some real-world problems.