Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Unix Windows Release License Coverage Downloads
Travis build status Appveyor build status github release license codecov status github downloads


Basic instructions for working with the code

  1. Clone (obtain code from online github repository): git clone --recursive

  2. Change working directory to STEPWAT2 folder: cd STEPWAT2

  3. Compile the code (make an executable application): make

Other tasks:

  • Clean local repository, e.g., after having run some tests: git clean -d -f

  • Reset files to their online github repository version, i.e., overwrite changes made to local files: git reset --hard

  • Pull down/sync latest commits/version from github repository: git pull

Code development and pull-requests

Basic instruction for running a test project

  • Print a brief explanation of options:
./stepwat --help
>   Usage : steppe [-d startdir] [-f] [-q] [-e] [-o] [-g]
>      -d : supply working directory (default=.)
>      -f : supply list of input files (
>      -q : quiet mode, don't print message to check logfile.
>      -p : prints progress bar
>      -e : echo initialization results to logfile
>      -o : write SOILWAT output to output files. Contains average over all iterations and standard deviation.
>      -g : use gridded mode
>      -i : write SOILWAT output to output files for each iteration
>-STdebug : generate sqlite database with STEPWAT information
  • Run the gridded version (-g) of STEPWAT2:
cd testing.sagebrush.master/
./stepwat -f -g
  • Run the non-gridded version of STEPWAT2 from the Stepwat_Inputs/ folder using SOILWAT2 to drive the water cycle:
cd testing.sagebrush.master/Stepwat_Inputs/
./stepwat -f
  • Run non-gridded version of STEPWAT using SOILWAT and output all variables passed between Stepwat and SOILWAT:
cd testing.sagebrush.master/Stepwat_Inputs/
./stepwat -f
  • Run STEPWAT2:
cd testing.sagebrush.master/Stepwat_Inputs/
./stepwat -f
  • Run STEPPE (get SOILWAT output for all iterations and average)
cd testing.sagebrush.master/Stepwat_Inputs/
./stepwat -f -o -i
  • Alternatively, use makefile targets (compile, copy, and execute in one command)
    • Non-gridded version, with SOILWAT2 water cycle, and with iteration and aggregated SOILWAT2-output:
      make bint_testing_nongridded
    • Gridded version with SOILWAT2 water cycle
      make bint_testing_gridded
    • If you need to clean up first, then run, e.g.,
      make cleanall bint_testing_nongridded

When switching development branches:

  • Checkout the new branch:
git checkout -b [branch name]
  • To ensure all submodules are updated correctly:
git submodule update --init --recursive

Doxygen documentation:

STEPWAT2 uses Doxygen to automatically generate documentation for the code base. For information on how to generate the documentation see our GitHub wiki.

Note: repository renamed from StepWat to STEPWAT2 on Feb 23, 2017

All existing information should automatically be redirected to the new name.

Contributors are encouraged, however, to update local clones to point to the new URL, i.e.,

git remote set-url origin