NatLabRockies / NatLabRockies/H2Integrate
Update/Expand docs for demand components
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
PR #631 re-classified the "open-loop converter control strategies" as demand components. The doc page for these demand components is docs/demand/demand_components.md. However, further documentation of these components is still needed in docs/user_guide/model_overview.md. The use of demand components would be greatly expanded in PR #666, which would give user's more exposure to these components in the Examples. Therefore, some additional documentation on how the connections worth these components and the calculations done in these components would be useful in the doc pages.
The figures in the demand doc pages should also be re-made to use a colorblind-friendly color palette.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading docs/demand/demand_components.md and docs/user_guide/model_overview.md, then review PRs #631 and #666 for the component classification and example usage. Update both pages with the connections and calculations described by the project, and remake the demand documentation figures with a colorblind-friendly palette.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100