Skip to content

SIP390 Document units as they appear in input files - #392

Merged
dlebauer merged 4 commits into
PecanProject:masterfrom
priyanshusky0:390-input-file-units
Sep 3, 2026
Merged

SIP390 Document units as they appear in input files#392
dlebauer merged 4 commits into
PecanProject:masterfrom
priyanshusky0:390-input-file-units

Conversation

@priyanshusky0

Copy link
Copy Markdown
Contributor

Fixes #390

The units columns listed internal model units rather than the units used in the input files, with the actual input units tucked into the notes.

Climate file (docs/user-guide/model-inputs.md)

Per src/sipnet/sipnet.c:216-224:

  • precip: cm → mm
  • vpd, vpdSoil, vPress: kPa → Pa
  • par: clarified the internal conversion instead of repeating the units column
  • Event parameters are documented as requiring no unit conversion.

sipnet.param (docs/parameters.md)

Per src/sipnet/sipnet.c:1873-1902:

  • baseVegResp, litterBreakdownRate, baseSoilResp: day⁻¹ → year⁻¹
  • All nine rates divided by 365 are now documented consistently.
  • Removed the introductory statement that all rates are per day.

Documentation only; no model behavior or input format changed.

Checklist

  • Related issues are listed above. PRs without an approved, related issue may not get reviewed.
  • PR title has the issue number in it ("[#<number>] <concise description of proposed change>")
  • Tests added/updated for new features (if applicable)
  • Documentation updated (if applicable)
  • docs/CHANGELOG.md updated with noteworthy changes
  • Code formatted with clang-format (run git clang-format if needed)

Note: See CONTRIBUTING.md for additional guidance. This repository uses automated formatting checks; if the pre-commit hook blocks your commit, run git clang-format to format staged changes.

The units columns listed internal model units rather than what users put in
the input files, with the actual input unit tucked into the notes.

Climate file (src/sipnet/sipnet.c:216-224):
- precip: cm -> mm
- vpd, vpdSoil, vPress: kPa -> Pa
- par: note the per-day conversion rather than restating the units column

sipnet.param (src/sipnet/sipnet.c:1873-1902):
- baseVegResp, litterBreakdownRate, baseSoilResp: day^-1 -> year^-1
- all nine rates that get divided by 365 now note the conversion the same way
- the intro no longer claims all rates are per day

Also note that event parameters take no unit conversion.

Docs only; no change to model behavior or input formats.
@dlebauer dlebauer changed the title [#390] Document units as they appear in input files SIP390 Document units as they appear in input files Sep 3, 2026

@dlebauer dlebauer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you! I'll defer to @Alomir to approve b/c I want him to confirm PAR description and units.

Comment thread docs/user-guide/model-inputs.md Outdated
Comment thread docs/user-guide/model-inputs.md Outdated

@dlebauer dlebauer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for the contribution @priyanshusky0

@dlebauer
dlebauer enabled auto-merge (squash) September 3, 2026 15:43
@dlebauer
dlebauer merged commit 6517bf9 into PecanProject:master Sep 3, 2026
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use input-file units consistently in SIPNET documentation

2 participants