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.

Sign up for GitHub

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

Jump to bottom

Document input units of biomass #265

Closed
dschlaep opened this issue Jul 12, 2019 · 0 comments
Closed

Document input units of biomass #265

dschlaep opened this issue Jul 12, 2019 · 0 comments
Assignees
@dschlaep
Labels
enhancement in progress
Milestone
Document code

Comments

@dschlaep
Copy link
Member

See #262

The biomass inputs and variables of SOILWAT2 are in units of grams per square meter as if that vegetation type covered 100 % of the area. To represent a vegetation with multiple vegetation types, SOILWAT2 scales these biomass values by fCover. For instance,

forbs: fCover = 0.4, biomass = 300 g/m2
grasses: fCover = 0.6, biomass = 450 g/m2
--> vegetation: fCover = 1, total biomass = 390 g/m2 (0.4 * 300 + 0.6 * 450) of which 120 g/m2 are forbs and 270 g/m2 are grasses

However, this is not abundantly made clear in the documentation or by code comments as demonstrated by DrylandEcology/STEPWAT2#346.

--> document expected units and add code comments
@dschlaep dschlaep added this to the Document code milestone Jul 12, 2019
@dschlaep dschlaep self-assigned this Jul 29, 2019
dschlaep added a commit that referenced this issue Oct 18, 2019
@dschlaep
Merge pull request #218 from DrylandEcology/Bugfix_117_Connor
acce170 
This version addressed documentation and unit testing:

User visible changes:
- Create and open documentation and user manual with `make doc doc_open`

Details:
- Documentation:
  - 'User manual' for SOILWAT2 provided as part of doxygen documentation (close #217, close #74)
  - Detailed installation instructions included in doxygen documentation (close #75)
  - Code contributor manual as part of doxygen documentation (close 86)
  - Doxygen warnings fixed (close #266)
  - Input units of biomass documented (close #265)

- Unit tests:
  - Contributed to the documentation and unit testing for all SOILWAT2 functions (see #216, see #219, see #76; close #73)
  - Unit tests for functions in `SW_Flow_lib.c` (close #117; contributed to #19)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dschlaep dschlaep

Labels
enhancement in progress
Projects
None yet
Milestone
Document code
Development

No branches or pull requests
1 participant
@dschlaep