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.
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.
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
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.
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.
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.
