OpenStudio-HPXML
Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.
https://github.com/NREL/OpenStudio-HPXML
Category: Consumption
Sub Category: Buildings and Heating
Last synced: about 9 hours ago
JSON representation
Repository metadata
Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.
- Host: GitHub
- URL: https://github.com/NREL/OpenStudio-HPXML
- Owner: NREL
- License: other
- Created: 2018-11-02T23:02:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-24T22:15:24.000Z (3 days ago)
- Last Synced: 2025-04-24T23:26:02.526Z (3 days ago)
- Language: Ruby
- Homepage:
- Size: 171 MB
- Stars: 52
- Watchers: 20
- Forks: 24
- Open Issues: 143
- Releases: 18
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE.md
README.md
OpenStudio®-HPXML
OpenStudio-HPXML allows running residential EnergyPlus™ simulations using an HPXML file for the building description.
It is intended to be used by user interfaces or other automated software workflows that automatically produce the HPXML file.
OpenStudio-HPXML can accommodate a wide range of different building technologies and geometries.
End-to-end simulations typically run in 3-10 seconds, depending on complexity, computer platform and speed, etc.
For more information on running simulations, generating HPXML files with the appropriate inputs to run EnergyPlus, etc., please visit the documentation.
Workflows
A simple run_simulation.rb script is provided to run a residential EnergyPlus simulation from an HPXML file.
See the Usage Instructions for documentation on running the workflow.
Since OpenStudio measures are used for model generation, additional OpenStudio-based workflows and interfaces can instead be used if desired.
Capabilities
OpenStudio-HPXML capabilities include:
- Modeling individual dwelling units or whole multifamily buildings
- Modeling a wide range of building technologies
- HVAC design load calculations and equipment autosizing
- Occupancy schedules (smooth or stochastic)
- Utility bill calculations (flat, tiered, time-of-use, real-time pricing, etc.)
- Emissions calculations (CO2e, etc.)
- Annual and timeseries outputs (energy, loads, temperatures, etc.)
- Optional HPXML inputs with transparent defaults
- Schematron and XSD Schema input validation
- Can be used for DOE HOMES program approval
- Can be used for ACCA Manual J approval
Measures
This repository contains several OpenStudio measures:
BuildResidentialHPXML: A measure that generates an HPXML file from a set of building description inputs (including, e.g., simplified geometry inputs).BuildResidentialScheduleFile: A measure that generates a CSV of detailed schedules (e.g., stochastic occupancy) for use in the simulation.HPXMLtoOpenStudio: A measure that translates an HPXML file to an OpenStudio model.ReportSimulationOutput: A reporting measure that generates a variety of simulation-based annual/timeseries outputs in CSV/JSON/MessagePack format.ReportUtilityBills: A reporting measure that generates utility bill outputs in CSV/JSON/MessagePack format.
Users
OpenStudio-HPXML is used by a number of software products or organizations, including:
- BEopt
- Clarity Heat Pump Toolkit
- Energy Rating Index (ERI)
- Home Energy Score
- OptiMiser
- Radiant Labs
- ResStock
- URBANopt
- VEIC
- Weatherization Assistant (pending)
- XeroHome
Are you using OpenStudio-HPXML and want to be mentioned here? Email us or open a Pull Request.
License
This project is available under a BSD-3-like license, which is a free, open-source, and permissive license. For more information, check out the license file.
Owner metadata
- Name: National Renewable Energy Laboratory
- Login: NREL
- Email:
- Kind: organization
- Description:
- Website: http://www.nrel.gov
- Location: Golden, CO
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/1906800?v=4
- Repositories: 599
- Last ynced at: 2024-12-18T09:41:07.898Z
- Profile URL: https://github.com/NREL
GitHub Events
Total
- Fork event: 9
- Create event: 100
- Release event: 2
- Issues event: 53
- Watch event: 7
- Delete event: 96
- Member event: 3
- Issue comment event: 103
- Push event: 1123
- Gollum event: 2
- Pull request event: 193
- Pull request review event: 396
- Pull request review comment event: 414
Last Year
- Fork event: 9
- Create event: 100
- Release event: 2
- Issues event: 53
- Watch event: 7
- Delete event: 96
- Member event: 3
- Issue comment event: 103
- Push event: 1123
- Gollum event: 2
- Pull request event: 193
- Pull request review event: 396
- Pull request review comment event: 414
Committers metadata
Last synced: 5 days ago
Total Commits: 11,978
Total Committers: 17
Avg Commits per committer: 704.588
Development Distribution Score (DDS): 0.546
Commits in past year: 1,432
Committers in past year: 10
Avg Commits per committer in past year: 143.2
Development Distribution Score (DDS) in past year: 0.543
| Name | Commits | |
|---|---|---|
| Scott Horowitz | s****z@n****v | 5435 |
| Joe Robertson | j****n@n****v | 2785 |
| GitHub Action | g****n | 1405 |
| Yueyue Zhou | y****u@n****v | 1150 |
| bpark1327 | b****k@n****v | 438 |
| Noel Merket | n****t@n****v | 219 |
| aspeake1 | a****e@n****v | 207 |
| Jeff Maguire | J****e@n****v | 91 |
| Rajendra Adhikari | r****e@g****m | 83 |
| prsh5175 | p****a@n****v | 53 |
| Sashadf1 | S****e@n****v | 46 |
| Shen | d****9@g****m | 31 |
| Jon | j****r@n****v | 20 |
| Anthony Fontanini | 3****i | 9 |
| Leo Rainer | l****r@l****v | 3 |
| Julien Marrec | j****c@g****m | 2 |
| mdahlhausen | m****n@g****m | 1 |
Committer domains:
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 516
Total pull requests: 1,582
Average time to close issues: 4 months
Average time to close pull requests: 18 days
Total issue authors: 24
Total pull request authors: 16
Average comments per issue: 1.1
Average comments per pull request: 0.86
Merged pull request: 1,407
Bot issues: 0
Bot pull requests: 0
Past year issues: 110
Past year pull requests: 252
Past year average time to close issues: 29 days
Past year average time to close pull requests: 8 days
Past year issue authors: 10
Past year pull request authors: 9
Past year average comments per issue: 0.72
Past year average comments per pull request: 0.43
Past year merged pull request: 215
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- shorowit (393)
- joseph-robertson (51)
- yzhou601 (9)
- chrisbalbach (9)
- jonwinkler (7)
- jmaguire1 (7)
- ejhw (6)
- rajeee (5)
- afontani (4)
- lixiliu (4)
- nmerket (3)
- jmarrec (3)
- pegdeploy (2)
- jefffriesen (2)
- ckm47 (2)
Top Pull Request Authors
- shorowit (1,140)
- joseph-robertson (272)
- yzhou601 (81)
- bpark1327 (28)
- jmaguire1 (14)
- rajeee (13)
- aspeake (9)
- Sashadf1 (6)
- nmerket (6)
- jonwinkler (3)
- prsh5175 (3)
- dshen109 (2)
- afontani (2)
- MatthewSteen (1)
- jmarrec (1)
Top Issue Labels
- enhancement (136)
- priority low (101)
- bug (89)
- priority medium (43)
- refactor (40)
- priority high (24)
- question (20)
- energyplus (19)
- hpxml (18)
- documentation (15)
- performance (14)
- openstudio (9)
- help wanted (3)
- invalid (1)
Top Pull Request Labels
- enhancement (178)
- refactor (80)
- bug (74)
- documentation (35)
- performance (18)
- openstudio (18)
- energyplus (15)
- hpxml (11)
- priority medium (8)
- priority high (2)
- priority low (2)
Package metadata
- Total packages: 2
- Total downloads: unknown
- Total dependent packages: 0 (may contain duplicates)
- Total dependent repositories: 0 (may contain duplicates)
- Total versions: 36
proxy.golang.org: github.com/nrel/openstudio-hpxml
- Homepage:
- Documentation: https://pkg.go.dev/github.com/nrel/openstudio-hpxml#section-documentation
- Licenses: other
- Latest release: v1.9.1 (published 5 months ago)
- Last Synced: 2025-04-26T13:40:01.758Z (1 day ago)
- Versions: 18
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 6.999%
- Average: 8.173%
- Dependent repos count: 9.346%
proxy.golang.org: github.com/NREL/OpenStudio-HPXML
- Homepage:
- Documentation: https://pkg.go.dev/github.com/NREL/OpenStudio-HPXML#section-documentation
- Licenses:
- Latest release: v1.9.1 (published 5 months ago)
- Last Synced: 2025-04-26T13:40:01.964Z (1 day ago)
- Versions: 18
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 6.999%
- Average: 8.173%
- Dependent repos count: 9.346%
Dependencies
- actions/checkout v3 composite
- actions/download-artifact v3 composite
- actions/upload-artifact v3 composite
- minitest = 5.15
- minitest-reporters >= 0
- msgpack >= 0
- oga >= 0
- parallel >= 0
- rake >= 0
- rubyzip >= 0
- simplecov >= 0
- simplecov-html >= 0
- ansi 1.5.0
- ast 2.4.2
- builder 3.2.4
- bundler 2.2.29
- docile 1.4.0
- minitest 5.15.0
- minitest-reporters 1.5.0
- msgpack 1.5.2
- oga 3.3
- parallel 1.22.1
- rake 13.0.6
- ruby-ll 2.1.2
- ruby-progressbar 1.11.0
- rubyzip 2.3.2
- simplecov 0.21.2
- simplecov-html 0.12.3
- simplecov_json_formatter 0.1.4
Score: -Infinity