OpenStudio-HPXML allows running residential EnergyPlus simulations using an HPXML file for the building description. A Schematron document (HPXMLtoOpenStudio/resources/EPvalidator.xml) for the EnergyPlus use case is used to validate that the appropriate HPXML inputs are provided to run EnergyPlus.

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

This repository contains several OpenStudio measures:

• 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 or JSON format.
• ReportHPXMLOutput: A reporting measure that generates a variety of HPXML-based outputs (including defaults like auto-sized HVAC systems) in CSV or JSON format.

The OpenStudio-HPXML workflow is used by a number of other residential projects, including:

• Energy Rating Index (ERI) and ENERGY STAR
• Home Energy Score
• UrbanOpt
• ResStock (pending)
• Weatherization Assistant (pending)

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.