Task

Review (and update) the parameters.md and model-structure.md documentation.

• Make sure that the mathematical notation in parameters.md is
  • 1. internally consistent.
  • 2. consistent with model-structure.md
  • 3. complete (there are a lot of variables with missing notation)
  • 4. clearly organized

outside scope: a comprehensive check of internal consistency of equations will be done during implementation.

Approach:

• Start with the two tables in the "Notation" section. Review these and see if they make sense. Ask if not.
• Then review tables in the "Run Time Parameters" section. Make sure that these are complete and consistent with way the notation is defined in the first two tables. Fill out any missing values.
• Cross-reference the "Run Time Parameters" with equations in "Model Specification" - make sure that the notation is consistent with how they are used in the model specification.
• Fix discrepancies. Ask if you have questions.

Final outcome should be a parameters.md file that is corrected so that it is complete and consistent with the notation in model-specification.md.

Start with the Notation section of parameters.md. This should be consistent with the equations in model-structure.md.

Please ask questions as they come up - either here, on Slack, or in PR discussions.