OpenStudio-HPXML
Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.
https://github.com/NatLabRockies/OpenStudio-HPXML
Category: Consumption
Sub Category: Buildings and Heating
Keywords from Contributors
building-energy carbon-emissions demand-side-management energy-consumption energy-data energy-efficiency
Last synced: about 4 hours ago
JSON representation
Repository metadata
Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.
- Host: GitHub
- URL: https://github.com/NatLabRockies/OpenStudio-HPXML
- Owner: NatLabRockies
- License: other
- Created: 2018-11-02T23:02:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2026-02-10T16:19:42.000Z (9 days ago)
- Last Synced: 2026-02-10T20:39:09.167Z (9 days ago)
- Language: Ruby
- Homepage:
- Size: 184 MB
- Stars: 61
- Watchers: 18
- Forks: 27
- Open Issues: 143
- Releases: 20
-
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 primarily 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
- Electric panel NEC load calculations (experimental research feature)
- 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 IRA HOMES Rebates approval
- Can be used for ACCA Manual J approval
- Can be used for automated calibration to utility bills
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
- Hot2000 (H2K)
- ICF
- OptiMiser
- Pearl
- 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 Laboratory of the Rockies
- Login: NatLabRockies
- 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: 2026-01-22T09:57:55.744Z
- Profile URL: https://github.com/NatLabRockies
GitHub Events
Total
- Delete event: 4
- Pull request event: 10
- Issues event: 1
- Issue comment event: 3
- Push event: 31
- Pull request review comment event: 9
- Pull request review event: 10
- Create event: 8
Last Year
- Delete event: 4
- Pull request event: 10
- Issues event: 1
- Issue comment event: 3
- Push event: 31
- Pull request review comment event: 9
- Pull request review event: 10
- Create event: 8
Committers metadata
Last synced: 4 days ago
Total Commits: 13,534
Total Committers: 20
Avg Commits per committer: 676.7
Development Distribution Score (DDS): 0.551
Commits in past year: 1,348
Committers in past year: 12
Avg Commits per committer in past year: 112.333
Development Distribution Score (DDS) in past year: 0.51
| Name | Commits | |
|---|---|---|
| Scott Horowitz | s****z@n****v | 6083 |
| Joe Robertson | j****n@n****v | 3074 |
| GitHub Action | g****n | 1753 |
| Yueyue Zhou | y****u@n****v | 1337 |
| bpark1327 | b****k@n****v | 448 |
| Noel Merket | n****t@n****v | 219 |
| aspeake1 | a****e@n****v | 207 |
| Sashadf1 | S****e@n****v | 100 |
| Jeff Maguire | J****e@n****v | 97 |
| Rajendra Adhikari | r****e@g****m | 83 |
| prsh5175 | p****a@n****v | 53 |
| Shen | d****9@g****m | 31 |
| Jon | j****r@n****v | 20 |
| Matt Steen | m****n@n****v | 12 |
| Anthony Fontanini | 3****i | 9 |
| Leo Rainer | l****r@l****v | 3 |
| Julien Marrec | j****c@g****m | 2 |
| Andrew Parker | a****2@g****m | 1 |
| JLReyna | j****a@n****v | 1 |
| mdahlhausen | m****n@g****m | 1 |
Committer domains:
Issue and Pull Request metadata
Last synced: 3 days ago
Total issues: 1
Total pull requests: 8
Average time to close issues: N/A
Average time to close pull requests: 15 days
Total issue authors: 1
Total pull request authors: 3
Average comments per issue: 0.0
Average comments per pull request: 0.5
Merged pull request: 2
Bot issues: 0
Bot pull requests: 0
Past year issues: 1
Past year pull requests: 8
Past year average time to close issues: N/A
Past year average time to close pull requests: 15 days
Past year issue authors: 1
Past year pull request authors: 3
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.5
Past year merged pull request: 2
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- shorowit (1)
Top Pull Request Authors
- joseph-robertson (4)
- shorowit (3)
- yzhou601 (1)
Top Issue Labels
Top Pull Request Labels
- refactor (1)
- bug (1)
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: 8.313852267398207