Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document variable naming #65

Open
VEZY opened this issue Apr 11, 2024 · 0 comments
Open

Document variable naming #65

VEZY opened this issue Apr 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@VEZY
Copy link
Member

VEZY commented Apr 11, 2024

  • A variable should be named using the standard name used in the community.
  • It shouldn’t include the variable unit, as it may depend on the unit of the model inputs.
  • The unit and description of the variable should be documented in the model structure documentation. If the unit depends on the inputs of the model, state it.
  • Variables should be snake case, e.g. leaf_area, unless widely used in the community, e.g. LAI
  • Variable names shouldn’t be abbreviated, unless widely used by the community, e.g. leaf area should be named leaf_area, not la. LAI should be fine, but leaf_area_index is better.
  • A variable should be named with a generic name, e.g. temperature instead of temperature_leaf, so the same name can be used at different scales. One exception is when a variable integrates the values from other scales; e.g. Rm_plant is fine if it is computed using the sum of all Rm of the organs in the plant.
@VEZY VEZY added the documentation Improvements or additions to documentation label Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant