urbanopt-cli 0.6.4 → 0.7.0

data/example_files/resources/hpxml-measures/ReportHPXMLOutput/measure.xml

@@ -0,0 +1,81 @@
+<?xml version="1.0"?>
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>report_hpxml_output</name>
+  <uid>9561a0d7-60ad-48c5-8337-2461df044d80</uid>
+  <version_id>eb9fbc8a-d525-48f0-9e73-8034cbb27b14</version_id>
+  <version_modified>20211106T154937Z</version_modified>
+  <xml_checksum>9BF1E6AC</xml_checksum>
+  <class_name>ReportHPXMLOutput</class_name>
+  <display_name>HPXML Output Report</display_name>
+  <description>Reports HPXML outputs for residential HPXML-based models.</description>
+  <modeler_description>Parses the HPXML file and reports pre-defined outputs.</modeler_description>
+  <arguments>
+    <argument>
+      <name>output_format</name>
+      <display_name>Output Format</display_name>
+      <description>The file format of the annual (and timeseries, if requested) outputs.</description>
+      <type>Choice</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+      <default_value>csv</default_value>
+      <choices>
+        <choice>
+          <value>csv</value>
+          <display_name>csv</display_name>
+        </choice>
+        <choice>
+          <value>json</value>
+          <display_name>json</display_name>
+        </choice>
+      </choices>
+    </argument>
+  </arguments>
+  <outputs />
+  <provenances />
+  <tags>
+    <tag>Reporting.QAQC</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ReportingMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>OpenStudio Application</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Parametric Analysis Tool</value>
+      <datatype>string</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>constants.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>AD439FC9</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>3.2.0</identifier>
+        <min_compatible>3.2.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>835EC0FA</checksum>
+    </file>
+    <file>
+      <filename>hpxml_output_report_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>A0F3407E</checksum>
+    </file>
+  </files>
+</measure>

data/example_files/resources/hpxml-measures/ReportHPXMLOutput/resources/constants.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+class BS
+  WallAboveGradeConditioned = 'Enclosure: Wall Area Thermal Boundary'
+  WallAboveGradeExterior = 'Enclosure: Wall Area Exterior'
+  WallBelowGrade = 'Enclosure: Foundation Wall Area Exterior'
+  FloorConditioned = 'Enclosure: Floor Area Conditioned'
+  FloorLighting = 'Enclosure: Floor Area Lighting'
+  Ceiling = 'Enclosure: Ceiling Area Thermal Boundary'
+  Roof = 'Enclosure: Roof Area'
+  Window = 'Enclosure: Window Area'
+  Door = 'Enclosure: Door Area'
+  DuctUnconditioned = 'Enclosure: Duct Area Unconditioned'
+  RimJoistAboveGradeExterior = 'Enclosure: Rim Joist Area'
+  SlabPerimeterExposedConditioned = 'Enclosure: Slab Exposed Perimeter Thermal Boundary'
+  HeatingSystem = 'Systems: Heating Capacity'
+  CoolingSystem = 'Systems: Cooling Capacity'
+  HeatPumpBackup = 'Systems: Heat Pump Backup Capacity'
+  WaterHeater = 'Systems: Water Heater Tank Volume'
+  FlowRateMechanicalVentilation = 'Systems: Mechanical Ventilation Flow Rate'
+
+  HeatingTotal = 'Design Loads Heating: Total'
+  HeatingDucts = 'Design Loads Heating: Ducts'
+  HeatingWindows = 'Design Loads Heating: Windows'
+  HeatingSkylights = 'Design Loads Heating: Skylights'
+  HeatingDoors = 'Design Loads Heating: Doors'
+  HeatingWalls = 'Design Loads Heating: Walls'
+  HeatingRoofs = 'Design Loads Heating: Roofs'
+  HeatingFloors = 'Design Loads Heating: Floors'
+  HeatingSlabs = 'Design Loads Heating: Slabs'
+  HeatingCeilings = 'Design Loads Heating: Ceilings'
+  HeatingInfilVent = 'Design Loads Heating: Infiltration/Ventilation'
+
+  CoolingSensibleTotal = 'Design Loads Cooling Sensible: Total'
+  CoolingSensibleDucts = 'Design Loads Cooling Sensible: Ducts'
+  CoolingSensibleWindows = 'Design Loads Cooling Sensible: Windows'
+  CoolingSensibleSkylights = 'Design Loads Cooling Sensible: Skylights'
+  CoolingSensibleDoors = 'Design Loads Cooling Sensible: Doors'
+  CoolingSensibleWalls = 'Design Loads Cooling Sensible: Walls'
+  CoolingSensibleRoofs = 'Design Loads Cooling Sensible: Roofs'
+  CoolingSensibleFloors = 'Design Loads Cooling Sensible: Floors'
+  CoolingSensibleSlabs = 'Design Loads Cooling Sensible: Slabs'
+  CoolingSensibleCeilings = 'Design Loads Cooling Sensible: Ceilings'
+  CoolingSensibleInfilVent = 'Design Loads Cooling Sensible: Infiltration/Ventilation'
+  CoolingSensibleIntGains = 'Design Loads Cooling Sensible: Internal Gains'
+
+  CoolingLatentTotal = 'Design Loads Cooling Latent: Total'
+  CoolingLatentDucts = 'Design Loads Cooling Latent: Ducts'
+  CoolingLatentInfilVent = 'Design Loads Cooling Latent: Infiltration/Ventilation'
+  CoolingLatentIntGains = 'Design Loads Cooling Latent: Internal Gains'
+
+  def self.get_units(cost_mult_type)
+    if cost_mult_type.include?('Area')
+      return 'ft^2'
+    elsif cost_mult_type.include?('Perimeter')
+      return 'ft'
+    elsif cost_mult_type.include?('Capacity')
+      return 'Btu/h'
+    elsif cost_mult_type.include?('Tank Volume')
+      return 'gal'
+    elsif cost_mult_type.include?('Flow Rate')
+      return 'cfm'
+    elsif cost_mult_type == 'Fixed'
+      return '1'
+    elsif cost_mult_type.include?('Design Loads')
+      return 'Btu/h'
+    end
+
+    fail "Unable to assign units to: #{cost_mult_type}"
+  end
+end

data/example_files/resources/hpxml-measures/ReportHPXMLOutput/tests/hpxml_output_report_test.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+require_relative '../../HPXMLtoOpenStudio/resources/minitest_helper'
+require_relative '../../HPXMLtoOpenStudio/resources/hpxml'
+require_relative '../../HPXMLtoOpenStudio/resources/xmlhelper'
+require 'oga'
+require 'openstudio'
+require 'openstudio/measure/ShowRunnerOutput'
+require 'fileutils'
+require 'csv'
+require_relative '../measure.rb'
+
+class ReportHPXMLOutputTest < MiniTest::Test
+  def test_hpxml_with_primary_systems
+    args_hash = { 'hpxml_path' => '../workflow/sample_files/base-hvac-multiple.xml' }
+    hpxml_csv = _test_measure(args_hash)
+    assert(File.exist?(hpxml_csv))
+    actual_rows = File.readlines(hpxml_csv).map { |x| x.split(',')[0].strip }.select { |x| !x.empty? }
+    assert_includes(actual_rows, 'Systems: Heating Capacity (Btu/h)')
+    assert_includes(actual_rows, 'Systems: Cooling Capacity (Btu/h)')
+    assert_includes(actual_rows, 'Primary Systems: Cooling Capacity (Btu/h)')
+    assert_includes(actual_rows, 'Primary Systems: Heating Capacity (Btu/h)')
+    assert_includes(actual_rows, 'Primary Systems: Heat Pump Backup Capacity (Btu/h)')
+    assert_includes(actual_rows, 'Secondary Systems: Cooling Capacity (Btu/h)')
+    assert_includes(actual_rows, 'Secondary Systems: Heating Capacity (Btu/h)')
+    assert_includes(actual_rows, 'Secondary Systems: Heat Pump Backup Capacity (Btu/h)')
+  end
+
+  def test_hpxml_without_primary_systems
+    hpxml = HPXML.new(hpxml_path: File.join(File.dirname(__FILE__), '..', '..', 'workflow', 'sample_files', 'base.xml'))
+    hpxml.hvac_systems.each do |hvac_system|
+      hvac_system.primary_system = false
+    end
+    tmp_hpxml_path = File.join(File.dirname(__FILE__), 'tmp.xml')
+    XMLHelper.write_file(hpxml.to_oga(), tmp_hpxml_path)
+    args_hash = { 'hpxml_path' => '../ReportHPXMLOutput/tests/tmp.xml' }
+    hpxml_csv = _test_measure(args_hash)
+    File.delete(tmp_hpxml_path) if File.exist?(tmp_hpxml_path)
+    assert(File.exist?(hpxml_csv))
+    actual_rows = File.readlines(hpxml_csv).map { |x| x.split(',')[0].strip }.select { |x| !x.empty? }
+    assert_includes(actual_rows, 'Systems: Heating Capacity (Btu/h)')
+    assert_includes(actual_rows, 'Systems: Cooling Capacity (Btu/h)')
+    refute_includes(actual_rows, 'Primary Systems: Cooling Capacity (Btu/h)')
+    refute_includes(actual_rows, 'Primary Systems: Heating Capacity (Btu/h)')
+    refute_includes(actual_rows, 'Primary Systems: Heat Pump Backup Capacity (Btu/h)')
+    refute_includes(actual_rows, 'Secondary Systems: Cooling Capacity (Btu/h)')
+    refute_includes(actual_rows, 'Secondary Systems: Heating Capacity (Btu/h)')
+    refute_includes(actual_rows, 'Secondary Systems: Heat Pump Backup Capacity (Btu/h)')
+  end
+
+  def test_furnace_and_central_air_conditioner_xml
+    args_hash = {}
+    hpxml_csv = _test_measure(args_hash)
+    assert(File.exist?(hpxml_csv))
+
+    expected_multipliers = {
+      'Enclosure: Wall Area Thermal Boundary (ft^2)' => 1200.0,
+      'Enclosure: Wall Area Exterior (ft^2)' => 1425.0,
+      'Enclosure: Foundation Wall Area Exterior (ft^2)' => 1200.0,
+      'Enclosure: Floor Area Conditioned (ft^2)' => 2700.0,
+      'Enclosure: Floor Area Lighting (ft^2)' => 2700.0,
+      'Enclosure: Ceiling Area Thermal Boundary (ft^2)' => 1350.0,
+      'Enclosure: Roof Area (ft^2)' => 1509.4,
+      'Enclosure: Window Area (ft^2)' => 360.0,
+      'Enclosure: Door Area (ft^2)' => 40.0,
+      'Enclosure: Duct Area Unconditioned (ft^2)' => 200.0,
+      'Enclosure: Rim Joist Area (ft^2)' => 115.6,
+      'Enclosure: Slab Exposed Perimeter Thermal Boundary (ft)' => 150.0,
+      'Systems: Heating Capacity (Btu/h)' => 36000.0,
+      'Systems: Cooling Capacity (Btu/h)' => 24000.0,
+      'Systems: Heat Pump Backup Capacity (Btu/h)' => 0.0,
+      'Systems: Water Heater Tank Volume (gal)' => 40.0,
+      'Systems: Mechanical Ventilation Flow Rate (cfm)' => 0.0,
+      'Primary Systems: Heating Capacity (Btu/h)' => 36000.0,
+      'Primary Systems: Cooling Capacity (Btu/h)' => 24000.0,
+      'Primary Systems: Heat Pump Backup Capacity (Btu/h)' => 0.0,
+      'Design Loads Heating: Total (Btu/h)' => 32302.0,
+      'Design Loads Heating: Ducts (Btu/h)' => 8597.0,
+      'Design Loads Heating: Windows (Btu/h)' => 7508.0,
+      'Design Loads Heating: Skylights (Btu/h)' => 0.0,
+      'Design Loads Heating: Doors (Btu/h)' => 575.0,
+      'Design Loads Heating: Walls (Btu/h)' => 6409.0,
+      'Design Loads Heating: Roofs (Btu/h)' => 0.0,
+      'Design Loads Heating: Floors (Btu/h)' => 0.0,
+      'Design Loads Heating: Slabs (Btu/h)' => 2446.0,
+      'Design Loads Heating: Ceilings (Btu/h)' => 2171.0,
+      'Design Loads Heating: Infiltration/Ventilation (Btu/h)' => 4597.0,
+      'Design Loads Cooling Sensible: Total (Btu/h)' => 17964.0,
+      'Design Loads Cooling Sensible: Ducts (Btu/h)' => 5216.0,
+      'Design Loads Cooling Sensible: Windows (Btu/h)' => 7127.0,
+      'Design Loads Cooling Sensible: Skylights (Btu/h)' => 0.0,
+      'Design Loads Cooling Sensible: Doors (Btu/h)' => 207.0,
+      'Design Loads Cooling Sensible: Walls (Btu/h)' => 265.0,
+      'Design Loads Cooling Sensible: Roofs (Btu/h)' => 0.0,
+      'Design Loads Cooling Sensible: Floors (Btu/h)' => 0.0,
+      'Design Loads Cooling Sensible: Slabs (Btu/h)' => 0.0,
+      'Design Loads Cooling Sensible: Ceilings (Btu/h)' => 2010.0,
+      'Design Loads Cooling Sensible: Infiltration/Ventilation (Btu/h)' => 619.0,
+      'Design Loads Cooling Sensible: Internal Gains (Btu/h)' => 2520.0,
+      'Design Loads Cooling Latent: Total (Btu/h)' => 0.0,
+      'Design Loads Cooling Latent: Ducts (Btu/h)' => 0.0,
+      'Design Loads Cooling Latent: Infiltration/Ventilation (Btu/h)' => 0.0,
+      'Design Loads Cooling Latent: Internal Gains (Btu/h)' => 0.0
+    }
+
+    actual_multipliers = {}
+    File.readlines(hpxml_csv).each do |line|
+      next if line.strip.empty?
+
+      key, value = line.split(',').map { |x| x.strip }
+      actual_multipliers[key] = Float(value)
+    end
+
+    assert_equal(expected_multipliers, actual_multipliers)
+  end
+
+  def test_air_source_heat_pump_xml
+    hpxml_files = ['base-hvac-air-to-air-heat-pump-1-speed.xml',
+                   'base-hvac-air-to-air-heat-pump-var-speed-backup-boiler.xml']
+    hpxml_files.each do |hpxml_file|
+      args_hash = { 'hpxml_path' => "../workflow/sample_files/#{hpxml_file}" }
+      hpxml_csv = _test_measure(args_hash)
+      assert(File.exist?(hpxml_csv))
+
+      if hpxml_file == 'base-hvac-air-to-air-heat-pump-1-speed.xml'
+        hp_capacity = 36000.0
+        backup_capacity = 36000.0
+      elsif hpxml_file == 'base-hvac-air-to-air-heat-pump-var-speed-backup-boiler.xml'
+        hp_capacity = 18000.0
+        backup_capacity = 60000.0
+      end
+
+      expected_multipliers = {
+        'Enclosure: Wall Area Thermal Boundary (ft^2)' => 1200.0,
+        'Enclosure: Wall Area Exterior (ft^2)' => 1425.0,
+        'Enclosure: Foundation Wall Area Exterior (ft^2)' => 1200.0,
+        'Enclosure: Floor Area Conditioned (ft^2)' => 2700.0,
+        'Enclosure: Floor Area Lighting (ft^2)' => 2700.0,
+        'Enclosure: Ceiling Area Thermal Boundary (ft^2)' => 1350.0,
+        'Enclosure: Roof Area (ft^2)' => 1509.4,
+        'Enclosure: Window Area (ft^2)' => 360.0,
+        'Enclosure: Door Area (ft^2)' => 40.0,
+        'Enclosure: Duct Area Unconditioned (ft^2)' => 200.0,
+        'Enclosure: Rim Joist Area (ft^2)' => 115.6,
+        'Enclosure: Slab Exposed Perimeter Thermal Boundary (ft)' => 150.0,
+        'Systems: Heating Capacity (Btu/h)' => hp_capacity,
+        'Systems: Cooling Capacity (Btu/h)' => hp_capacity,
+        'Systems: Heat Pump Backup Capacity (Btu/h)' => backup_capacity,
+        'Systems: Water Heater Tank Volume (gal)' => 40.0,
+        'Systems: Mechanical Ventilation Flow Rate (cfm)' => 0.0,
+        'Primary Systems: Heating Capacity (Btu/h)' => hp_capacity,
+        'Primary Systems: Cooling Capacity (Btu/h)' => hp_capacity,
+        'Primary Systems: Heat Pump Backup Capacity (Btu/h)' => backup_capacity,
+        'Design Loads Heating: Total (Btu/h)' => 31214.0,
+        'Design Loads Heating: Ducts (Btu/h)' => 7508.0,
+        'Design Loads Heating: Windows (Btu/h)' => 7508.0,
+        'Design Loads Heating: Skylights (Btu/h)' => 0.0,
+        'Design Loads Heating: Doors (Btu/h)' => 575.0,
+        'Design Loads Heating: Walls (Btu/h)' => 6409.0,
+        'Design Loads Heating: Roofs (Btu/h)' => 0.0,
+        'Design Loads Heating: Floors (Btu/h)' => 0.0,
+        'Design Loads Heating: Slabs (Btu/h)' => 2446.0,
+        'Design Loads Heating: Ceilings (Btu/h)' => 2171.0,
+        'Design Loads Heating: Infiltration/Ventilation (Btu/h)' => 4597.0,
+        'Design Loads Cooling Sensible: Total (Btu/h)' => 17964.0,
+        'Design Loads Cooling Sensible: Ducts (Btu/h)' => 5216.0,
+        'Design Loads Cooling Sensible: Windows (Btu/h)' => 7127.0,
+        'Design Loads Cooling Sensible: Skylights (Btu/h)' => 0.0,
+        'Design Loads Cooling Sensible: Doors (Btu/h)' => 207.0,
+        'Design Loads Cooling Sensible: Walls (Btu/h)' => 265.0,
+        'Design Loads Cooling Sensible: Roofs (Btu/h)' => 0.0,
+        'Design Loads Cooling Sensible: Floors (Btu/h)' => 0.0,
+        'Design Loads Cooling Sensible: Slabs (Btu/h)' => 0.0,
+        'Design Loads Cooling Sensible: Ceilings (Btu/h)' => 2010.0,
+        'Design Loads Cooling Sensible: Infiltration/Ventilation (Btu/h)' => 619.0,
+        'Design Loads Cooling Sensible: Internal Gains (Btu/h)' => 2520.0,
+        'Design Loads Cooling Latent: Total (Btu/h)' => 0.0,
+        'Design Loads Cooling Latent: Ducts (Btu/h)' => 0.0,
+        'Design Loads Cooling Latent: Infiltration/Ventilation (Btu/h)' => 0.0,
+        'Design Loads Cooling Latent: Internal Gains (Btu/h)' => 0.0
+      }
+
+      actual_multipliers = {}
+      File.readlines(hpxml_csv).each do |line|
+        next if line.strip.empty?
+
+        key, value = line.split(',').map { |x| x.strip }
+        actual_multipliers[key] = Float(value)
+      end
+
+      assert_equal(expected_multipliers, actual_multipliers)
+    end
+  end
+
+  def _test_measure(args_hash)
+    # Run measure via OSW
+    require 'json'
+    template_osw = File.join(File.dirname(__FILE__), '..', '..', 'workflow', 'template.osw')
+    workflow = OpenStudio::WorkflowJSON.new(template_osw)
+    json = JSON.parse(workflow.to_s)
+
+    # Update measure args
+    steps = OpenStudio::WorkflowStepVector.new
+    found_args = []
+    json['steps'].each do |json_step|
+      step = OpenStudio::MeasureStep.new(json_step['measure_dir_name'])
+      json_step['arguments'].each do |json_arg_name, json_arg_val|
+        if args_hash.keys.include? json_arg_name
+          # Override value
+          found_args << json_arg_name
+          json_arg_val = args_hash[json_arg_name]
+        end
+        step.setArgument(json_arg_name, json_arg_val)
+      end
+      steps.push(step)
+    end
+    workflow.setWorkflowSteps(steps)
+    osw_path = File.join(File.dirname(template_osw), 'test.osw')
+    workflow.saveAs(osw_path)
+    assert_equal(args_hash.size, found_args.size)
+
+    # Run OSW
+    success = system("#{OpenStudio.getOpenStudioCLI} run -w #{osw_path}")
+    assert_equal(true, success)
+
+    # Cleanup
+    File.delete(osw_path)
+
+    hpxml_csv = File.join(File.dirname(template_osw), 'run', 'results_hpxml.csv')
+    return hpxml_csv
+  end
+end