Unix | Windows | Release | License | Coverage | Downloads |
---|---|---|---|---|---|
1) Clone (obtain code from online github repository):
git clone --recursive https://github.com/DrylandEcology/STEPWAT2.git
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
./stepwat --help
> Usage : steppe [-d startdir] [-f files.in] [-q] [-e] [-o] [-g]
> -d : supply working directory (default=.)
> -f : supply list of input files (default=files.in)
> -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
cd testing.sagebrush.master/
./stepwat -f files.in -g
cd testing.sagebrush.master/Stepwat_Inputs/
./stepwat -f files.in
cd testing.sagebrush.master/Stepwat_Inputs/
./stepwat -f files.in -ssxwdebug.in
cd testing.sagebrush.master/Stepwat_Inputs/
./stepwat -f files.in
cd testing.sagebrush.master/Stepwat_Inputs/
./stepwat -f files.in -o -i
makefile
targets (compile, copy, and execute in one command)
make bint_testing_nongridded
make bint_testing_gridded
make cleanall bint_testing_nongridded
git checkout -b [branch name]
git submodule update --init --recursive
Depending on the purpose of the development branch the new output should be exactly the same as reference output or differ in specific ways in specific variables.
The following steps provide a starting point for such comparisons:
# Simulate on master branch and copy output to "Output_ref"
git checkout master
make clean bint_testing_nongridded
cp -r testing.sagebrush.master/Stepwat_Inputs/Output testing.sagebrush.master/Stepwat_Inputs/Output_ref
# Switch to development branch <branch_xxx> and run the same simulation
git checkout <branch_xxx>
make clean bint_testing_nongridded
# Compare the two sets of outputs
# * Lists all output files and determine if they are exactly they same
diff -qsr testing.sagebrush.master/Stepwat_Inputs/Output testing.sagebrush.master/Stepwat_Inputs/Output_ref
# * Produce two figures (scatter plots and time series of biomass)
# that are saved as PDFs at testing.sagebrush.master/
Rscript tools/compare_bmassavg_against_ref.R
STEPWAT2 uses Doxygen to automatically generate documentation for the code base. For information on how to generate the documentation see our GitHub wiki.
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 https://github.com/Burke-Lauenroth-Lab/STEPWAT2.git