NOAA-OWP / LGAR-C

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

Closed peterlafollette closed 6 months ago

peterlafollette commented 6 months ago

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

  1. No computational changes have been made, so no testing has occurred aside from the integrated tests.

Screenshots

Notes

-

Todos

-

Checklist

Testing checklist

Target Environment support

Accessibility

Other

rlmcdaniel commented 6 months ago

As discussed:

  1. Typo in the range tested for stability for theta_r
  2. Add where to set all calibratable parameters
  3. Suggest adding units to the textural class table in addition to the description