Skip to content

Add calibration section to tech note #3924

@linniahawkins

Description

@linniahawkins

(Please see our contribution guidelines for documentation.)

What sort(s) of documentation issue is this?

  • Something is missing.
  • Something is (or might be) incorrect or outdated.
  • Something is confusing.
  • Something is broken.

What part(s) of the documentation does this concern?

  • Technical Note (science and design of the model)
  • User's Guide (using the model and related tools)
  • Somewhere else (e.g., README file, tool help text, or code comment): Please specify
  • I don't know

Describe the issue

I will add a section to the tech note that describes the calibration at a high level. This way, everywhere in the tech note where parameter values are stated, other people can reference/link to this section. @adrifoster For example:

In the LUNA module, Jmaxb0 and Jmaxb1 parameters were set based on Ali et al., (), but were subject to calibration (see section ..**).

Additional context (optional)

@samsrabin is planning to magically automatically update parameter values in the documentation from the paramfile so this language will help to avoid additional verbiage changes as parameter values are updated (see #3923).

Metadata

Metadata

Assignees

Labels

bfbbit-for-bitdocs-loc:tech-noteRelates to Technical Note (science)docs:newNew documentation needed (e.g., for a new feature)documentationadditions or edits to user-facing documentation or its infrastructure

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions