google / google/digitalbuildings

Add more model documentation

Open
#1,217 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
461
Forks
178
Avg merge
9h 26m
Merged PRs (30d)
5

Description

Create documentation outlining the model decisions made in the last few months:
- ASHP
- Alarm selection
- Energy meters vs heat meters
- Generators
- ATS
- Fan speed modes (TWENTY_PERCENT, etc.)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the repository’s existing documentation and the history behind the listed model decisions. Document the decisions for ASHP, alarm selection, energy versus heat meters, generators, ATS, and fan speed modes, using terminology consistent with the project. Done means all six topics are covered in a discoverable documentation page.

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
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.