This is the repository for the SHETRAN Hydrological Model.
Details of features and the history of the program itself can be found on the webpage.
Download the zip file from the latest release and then extract it.
Double click on exectuable, e.g. 'shetran.exe' in the shetran folder that has been extracted. Then select a rundata file from one of the examples data sets.
See COMPILING.md for instructions on how to compile the program.
For iterative local development builds on Windows, use build.bat -t Release --clean-app to rebuild SHETRAN quickly without rebuilding external libraries.
The equivalent Linux command is nearly identical: ./build.sh -t Release --clean-app.
This project is setup to support FORD for in-code documentation. The current state of the documentation can be generated from the project root using either:
build.bat --docs-onlyor directly via FORD:
ford -o docs\ford .\ford_project.mdThe generated documentation entry point is FORD index.