OpenStudio-HPXML v1.1.0
OpenStudio-HPXML version 1.1.0 has been released. Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files.
The OpenStudio-HPXML workflow uses HPXML building description files to run residential simulations on the Department of Energy's OpenStudio/EnergyPlus building simulation platform.
OpenStudio-HPXML v1.1.0 uses OpenStudio v3.1.0, EnergyPlus v9.4.0, and a proposed HPXML v3.1.
Please visit the OpenStudio-HPXML v1.1.0 documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc.
New Features
- Breaking change:
Type
is now a required input for dehumidifiers; can be "portable" or "whole-home". - Breaking change:
Location
is now a required input for dehumidifiers; must be "living space" as dehumidifiers are currently modeled as located in living space. - Breaking change:
Type
is now a required input for Pool, PoolPump, HotTub, and HotTubPump. - Breaking change: Both supply and return duct leakage to outside are now required inputs for AirDistribution systems.
- Breaking change: Simplifies inputs for fan coils and water loop heat pumps by A) removing HydronicAndAirDistribution element and B) moving WLHP inputs from extension elements to HeatPump element.
- Allows modeling airflow/charge defects for air conditioners, heat pumps, and furnaces (RESNET Standard 310).
- Allows modeling multiple dehumidifiers (previously only one allowed).
- Allows modeling generators (generic on-site power production).
- Allows detailed heating/cooling setpoints to be specified: 24-hour weekday & weekend values.
- Allows modeling window/skylight exterior shading via summer/winter shading coefficients.
- Allows JSON annual/timeseries output files to be generated instead of CSV. Breaking change: For CSV outputs, the first two sections in the results_annual.csv file are now prefixed with "Fuel Use:" and "End Use:", respectively.
- Allows more defaulting (optional inputs) for a variety of HPXML elements.
- Allows requesting timeseries unmet heating/cooling loads.
- Allows skipping schema/schematron validation (for speed); should only be used if the HPXML was already validated upstream.
- Allows HPXML files w/ multiple
Building
elements; requires providing the ID of the single building to be simulated. - Includes hot water loads (in addition to heating/cooling loads) when timeseries total loads are requested.
- The
in.xml
HPXML file is now always produced for inspection of default values (e.g., autosized HVAC capacities). Breaking change: Theoutput_dir
HPXMLtoOpenStudio measure argument is now required. - Overhauls documentation to be more comprehensive and standardized.
run_simulation.rb
now returns exit code 1 if not successful (i.e., either invalid inputs or simulation fails).
Bugfixes
- Improved modeling of window/skylight interior shading -- better reflects shading coefficient inputs.
- Adds error-checking on the HPXML schemaVersion.
- Adds various error-checking to the schematron validator.
- Adds error-checking for empty IDs in the HPXML file.
- Fixes heat pump water heater fan energy not included in SimulationOutputReport outputs.
- Fixes possibility of incorrect "A neighbor building has an azimuth (XXX) not equal to the azimuth of any wall" error.
- Fixes possibility of errors encountered before schematron validation has occurred.
- Small bugfixes related to basement interior surface solar absorptances.
- Allows NumberofConditionedFloors/NumberofConditionedFloorsAboveGrade to be non-integer values per the HPXML schema.
- HVAC sizing design load improvements for floors above crawlspaces/basements, walls, ducts, and heat pumps.
- Now recognizes Type="none" to prevent modeling of pools and hot tubs (pumps and heaters).
- Fixes error for overhangs with zero depth.
- Fixes possible error where the normalized flue height for the AIM-2 infiltration model is negative.
- Slight adjustment of default water heater recovery efficiency equation to prevent errors from values being too high.
- Fixes schematron file not being valid per ISO Schematron standard.