Skip to content

Use input-file units consistently in SIPNET documentation #390

Description

@dlebauer

Description

SIPNET input documentation should document units as they are provided by users, rather than units used internally by the model.

Review:

  • docs/user-guide/model-inputs.md for climate and event inputs
  • docs/parameters.md for sipnet.param parameters

Check the corresponding input parsing code and update documented units to match the input files. Where SIPNET converts units internally, note the conversion only where useful.

For example, precipitation is supplied in mm and converted internally to cm, while vapor pressure is supplied in Pa and converted to kPa.

This is a documentation-only change; do not change model behavior or input formats.

—-

The SIPNET interface functions in the PEcAn repository, convert between PEcAn-standard units (not relevant here) and SIPNET input/output units and can help by providing a secondary source of information ab some of the units in input and output files:

  • models/sipnet/R/write.configs.SIPNET.R
  • models/sipnet/R/met2model.SIPNET.R
  • models/sipnet/R/write.events.SIPNET.R
  • models/sipnet/R/model2netcdf.SIPNET.R

If there is a discrepancy, sipnet source code is the authoritative source and there may be a bug in the pecan code; reach out on the pecan slack channel or file an issue in the pecan repository.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions