NatLabRockies / NatLabRockies/OpenStudio
OpenStudio Model Object class names do not match E+ names
Open
Nobody has claimed this yet.
component - Documentation
component - Model
- Dominant language
- C++
- Stars
- 646
- Forks
- 237
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 10
Description
Several model object class names do not match the names of their E+ counterparts. This increases the documentation burden and confuses users.
Different names are justified when the OpenStudio model deviates from the E+ counterpart but we should not be using these when they are one to one.
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
No files, tests, or entry points are identified. Start by inventorying OpenStudio model object class names and comparing them with their EnergyPlus counterparts. Done means the one-to-one names are aligned while names remain distinct where the OpenStudio model deviates.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100