Lumped Arid/Semi-arid Model (LASAM) simulates infiltration and surface runoff (two important components of the hydrologic cycle) based on Layered Green-Ampt with redistribution (LGAR) model
Other
1
stars
4
forks
source link
Adding documentation for calibratable parameters #24
In anticipation of the knowledge transfer, descriptions of calibratable parameters have been added.
Additions
-data/README.md has been added. It gives the list of calibratable parameters, including their name, units, physical limits, range included in stability testing, whether the parameter applies to individual soil layers or the whole model domain, and a description. General notes on parameters are then given, followed by example values from literature.
Removals
-
Changes
-The README in the main repo has been updated to give a clearer description of why the model should be applied in arid or semi-arid areas, as well as with a link to the calibratable parameters description. Note that this link will only work when the PR is merged to master, because the link is to the readme in the master branch, which will exist after the PR is approved.
Testing
No computational changes have been made, so no testing has occurred aside from the integrated tests.
Screenshots
Notes
-
Todos
-
Checklist
[x] PR has an informative and human-readable title
[x] Changes are limited to a single goal (no scope creep)
[x] Code can be automatically merged (no conflicts)
[x] Code follows project standards (link if applicable)
[x] Passes all existing automated tests
[x] Any change in functionality is tested
[x] New functions are documented (with a description, list of inputs, and expected output)
[x] Placeholder code is flagged / future todos are captured in comments
[x] Visually tested in supported browsers and devices (see checklist below :point_down:)
[x] Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
[x] Reviewers requested with the Reviewers tool :arrow_right:
In anticipation of the knowledge transfer, descriptions of calibratable parameters have been added.
Additions
-data/README.md has been added. It gives the list of calibratable parameters, including their name, units, physical limits, range included in stability testing, whether the parameter applies to individual soil layers or the whole model domain, and a description. General notes on parameters are then given, followed by example values from literature.
Removals
-
Changes
-The README in the main repo has been updated to give a clearer description of why the model should be applied in arid or semi-arid areas, as well as with a link to the calibratable parameters description. Note that this link will only work when the PR is merged to master, because the link is to the readme in the master branch, which will exist after the PR is approved.
Testing
Screenshots
Notes
-
Todos
-
Checklist
Testing checklist
Target Environment support
Accessibility
Other