urbanopt-cli 0.6.2 → 0.7.1

data/example_files/resources/hpxml-measures/Changelog.md

@@ -1,21 +1,97 @@
-## OpenStudio-HPXML v1.2.0 (Pending)
+## OpenStudio-HPXML v1.3.0
+
+__New Features__
+- Updates to OpenStudio 3.3.0/EnergyPlus 9.6.0.
+- **Breaking change**: Replaces "Unmet Load" outputs with "Unmet Hours".
+- **Breaking change**: Renames "Load: Heating" and "Peak Load: Heating" (and Cooling) outputs to include "Delivered".
+- **Breaking change**: Any heat pump backup heating requires `HeatPump/BackupType` ("integrated" or "separate") to be specified.
+- **Breaking change**: For homes with multiple PV arrays, all inverter efficiencies must have the same value.
+- **Breaking change**: HPXML schema version must now be '4.0' (proposed).
+  - Moves `ClothesDryer/extension/IsVented` to `ClothesDryer/IsVented`.
+  - Moves `ClothesDryer/extension/VentedFlowRate` to `ClothesDryer/VentedFlowRate`.
+  - Moves `FoundationWall/Insulation/Layer/extension/DistanceToTopOfInsulation` to `FoundationWall/Insulation/Layer/DistanceToTopOfInsulation`.
+  - Moves `FoundationWall/Insulation/Layer/extension/DistanceToBottomOfInsulation` to `FoundationWall/Insulation/Layer/DistanceToBottomOfInsulation`.
+  - Moves `Slab/PerimeterInsulationDepth` to `Slab/PerimeterInsulation/Layer/InsulationDepth`.
+  - Moves `Slab/UnderSlabInsulationWidth` to `Slab/UnderSlabInsulation/Layer/InsulationWidth`.
+  - Moves `Slab/UnderSlabInsulationSpansEntireSlab` to `Slab/UnderSlabInsulation/Layer/InsulationSpansEntireSlab`.
+- Initial release of BuildResidentialHPXML measure, which generates an HPXML file from a set of building description inputs.
+- Expanded capabilities for scheduling:
+  - Allows modeling detailed occupancy via a schedule CSV file.
+  - Introduces a measure for automatically generating detailed smooth/stochastic schedule CSV files.
+  - Expands simplified weekday/weekend/monthly schedule inputs to additional building features.
+  - Allows `HeatingSeason` & `CoolingSeason` to be specified for defining heating and cooling equipment availability.
+- Adds a new results_hpxml.csv output file to summarize HPXML values (e.g., surface areas, HVAC capacities).
+- Allows modeling lithium ion batteries.
+- Allows use of `HeatPump/BackupSystem` for modeling a standalone (i.e., not integrated) backup heating system.
+- Allows conditioned crawlspaces to be specified; modeled as crawlspaces that are actively maintained at setpoint.
+- Allows non-zero refrigerant charge defect ratios for ground source heat pumps.
+- Expands choices allowed for `Siding` (Wall/RimJoist) and `RoofType` (Roof) elements.
+- Allows "none" for wall/rim joist siding.
+- Allows interior finish inputs (e.g., 0.5" drywall) for walls, ceilings, and roofs.
+- Allows specifying the foundation wall type (e.g., solid concrete, concrete block, wood, etc.).
+- Allows additional fuel types for generators.
+- Switches to the EnergyPlus Fan:SystemModel object for all HVAC systems.
+- Introduces a small amount of infiltration for unvented spaces.
+- Updates the assumption of flue losses vs tank losses for higher efficiency non-electric storage water heaters.
+- Revises shared mechanical ventilation preconditioning control logic to operate less often.
+- Adds alternative inputs:
+  - Window/skylight physical properties (`GlassLayers`, `FrameType`, etc.) instead of `UFactor` & `SHGC`.
+  - `Ducts/FractionDuctArea` instead of `Ducts/DuctSurfaceArea`.
+  - `Length` instead of `Area` for foundation walls.
+  - `Orientation` instead of `Azimuth` for all applicable surfaces, PV systems, and solar thermal systems.
+  - CEER (Combined Energy Efficiency Ratio) instead of EER for room ACs.
+  - `UsageBin` instead of `FirstHourRating` (for water heaters w/ UEF metric).
+  - `CFM50` instead of `CFM25` or `Percent` for duct leakage.
+- Allows more defaulting (optional inputs):
+  - Mechanical ventilation airflow rate per ASHRAE 62.2-2019.
+  - HVAC/DHW system efficiency (by age).
+  - Mechanical ventilation fan power (by type).
+  - Color (solar absorptance) for walls, roofs, and rim joists.
+  - Foundation wall distance to top/bottom of insulation.
+  - Door azimuth.
+  - Radiant barrier grade.
+  - Whole house fan airflow rate and fan power.
+- Adds more warnings of inputs based on ANSI/BPI 2400 Standard.
+- Removes error-check for number of bedrooms based on conditioned floor area, per RESNET guidance.
+- Updates the reporting measure to register all outputs from the annual CSV with the OS runner (for use in, e.g., PAT).
+- Removes timeseries CSV output columns that are all zeroes to reduce file size and processing time.
+- Improves consistency of installation quality calculations for two/variable-speed air source heat pumps and ground source heat pumps.
+- Relaxes requirement for heating (or cooling) setpoints so that they are only needed if heating (or cooling) equipment is present.
+- Adds an `--ep-input-format` argument to run_simulation.rb to choose epJSON as the EnergyPlus input file format instead of IDF.
+- Eliminates EnergyPlus warnings related to unused objects or invalid output meters/variables.
+- Allows modeling PTAC and PTHP HVAC systems. 
+- Allows user inputs for partition wall mass and furniture mass.
+
+__Bugfixes__
+- Improves ground reflectance when there is shading of windows/skylights.
+- Improves HVAC fan power for central forced air systems.
+- Fixes mechanical ventilation compartmentalization area calculation for SFA/MF homes with surfaces with InteriorAdjacentTo==ExteriorAdjacentTo.
+- Negative `DistanceToTopOfInsulation` values are now disallowed.
+- Fixes workflow errors if a `VentilationFan` has zero airflow rate or zero hours of operation.
+- Fixes duct design load calculations for HPXML files with multiple ducted HVAC systems.
+- Fixes ground source heat pump rated airflow.
+- Relaxes `Overhangs` DistanceToBottomOfWindow vs DistanceToBottomOfWindow validation when Depth is zero.
+- Fixes possibility of double-counting HVAC distribution losses if an `HVACDistribution` element has both AirDistribution properties and DSE values
+- Fixes possibility of incorrect "Peak Electricity: Winter Total (W)" and "Peak Electricity: Summer Total (W)" outputs for homes with duct losses.
+- Fixes heating/cooling seasons (used for e.g. summer vs winter window shading) for the southern hemisphere.
+- Fixes possibility of EnergyPlus simulation failure for homes with ground-source heat pumps and airflow and/or charge defects.
+- Fixes peak load/electricity outputs for homes with ground-source heat pumps and airflow and/or charge defects.
+
+## OpenStudio-HPXML v1.2.0
 
 __New Features__
-- Updates to OpenStudio 3.2.0/EnergyPlus 9.5.0.
 - **Breaking change**: Heating/cooling component loads no longer calculated by default for faster performance; use `--add-component-loads` argument if desired.
 - **Breaking change**: Replaces `Site/extension/ShelterCoefficient` with `Site/ShieldingofHome`.
-- **Breaking change**: `AirDistributionType` is now required for all air distribution systems.
-- Allows additional fuel types for generators.
-- Allows `DuctLeakageMeasurement` & `ConditionedFloorAreaServed` to not be specified for ductless fan coil systems.
+- Allows `DuctLeakageMeasurement` & `ConditionedFloorAreaServed` to not be specified for ductless fan coil systems; **Breaking change**: `AirDistributionType` is now required for all air distribution systems.
 - Allows `Slab/ExposedPerimeter` to be zero.
 - Removes `ClothesDryer/ControlType` from being a required input, it is not used.
 - Switches room air conditioner model to use Cutler performance curves.
-- Adds an `--ep-input-format` argument to run_simulation.rb to choose epJSON as the EnergyPlus input file format instead of IDF.
 - Relaxes tolerance for duct leakage to outside warning when ducts solely in conditioned space.
+- Removes limitation that a shared water heater serving a shared laundry room can't also serve dwelling unit fixtures (i.e., FractionDHWLoadServed is no longer required to be zero).
+- Adds IDs to schematron validation errors/warnings when possible.
 - Moves additional error-checking from the ruby measure to the schematron validator. 
 
 __Bugfixes__
-- Improves ground reflectance when there is shading of windows/skylights.
 - Fixes room air conditioner performance curve.
 - Fixes ruby error if elements (e.g., `SystemIdentifier`) exist without the proper 'id'/'idref' attribute.
 - Fixes error if boiler/GSHP pump power is zero
@@ -246,4 +322,4 @@ __Bugfixes__
 
 ## OpenStudio-HPXML v0.7.0 Beta
 
-- Initial beta release
+- Initial beta release

data/example_files/resources/hpxml-measures/Gemfile

@@ -9,3 +9,6 @@ gem 'rake'
 gem 'minitest', '~> 5.9'
 gem 'minitest-reporters'
 gem 'parallel'
+gem 'simplecov'
+gem 'simplecov-html'
+gem 'rubyzip'

data/example_files/resources/hpxml-measures/Gemfile.lock

@@ -4,16 +4,7 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     builder (3.2.4)
-    ci_reporter (2.0.0)
-      builder (>= 2.1.2)
-    ci_reporter_minitest (1.0.0)
-      ci_reporter (~> 2.0)
-      minitest (~> 5.0)
-    codecov (0.2.12)
-      json
-      simplecov
     docile (1.3.5)
-    json (2.5.1)
     mini_portile2 (2.5.0)
     minitest (5.14.4)
     minitest-reporters (1.4.3)
@@ -36,6 +27,7 @@ GEM
       ansi
       ast
     ruby-progressbar (1.11.0)
+    rubyzip (2.3.2)
     schematron-nokogiri (0.0.3)
       nokogiri (~> 1.6)
     simplecov (0.21.2)
@@ -50,16 +42,16 @@ PLATFORMS
   x64-mingw32
 
 DEPENDENCIES
-  ci_reporter_minitest (~> 1.0.0)
-  codecov (= 0.2.12)
   minitest (~> 5.9)
   minitest-reporters
   nokogiri (~> 1.10)
   oga
   parallel
   rake
+  rubyzip
   schematron-nokogiri
   simplecov
+  simplecov-html
 
 BUNDLED WITH
    2.2.11