openstudio-common-measures 0.4.0 → 0.6.1

data/lib/measures/generic_qaqc/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>generic_qaqc</name>
   <uid>d58d6b29-69ba-4915-b907-3c2c37ddb7c7</uid>
-  <version_id>20e401a2-9dd1-4a18-83aa-99fc46a4cea2</version_id>
-  <version_modified>20210423T144537Z</version_modified>
+  <version_id>d828bb8b-a051-4f95-96eb-e42035d8b7e3</version_id>
+  <version_modified>20220622T165904Z</version_modified>
   <xml_checksum>0A3BF61C</xml_checksum>
   <class_name>GenericQAQC</class_name>
   <display_name>Generic QAQC</display_name>
@@ -44,12 +44,44 @@
           <value>90.1-2013</value>
           <display_name>90.1-2013</display_name>
         </choice>
+        <choice>
+          <value>90.1-2016</value>
+          <display_name>90.1-2016</display_name>
+        </choice>
+        <choice>
+          <value>90.1-2019</value>
+          <display_name>90.1-2019</display_name>
+        </choice>
+        <choice>
+          <value>ComStock DOE Ref Pre-1980</value>
+          <display_name>ComStock DOE Ref Pre-1980</display_name>
+        </choice>
+        <choice>
+          <value>ComStock DOE Ref 1980-2004</value>
+          <display_name>ComStock DOE Ref 1980-2004</display_name>
+        </choice>
+        <choice>
+          <value>ComStock 90.1-2004</value>
+          <display_name>ComStock 90.1-2004</display_name>
+        </choice>
+        <choice>
+          <value>ComStock 90.1-2007</value>
+          <display_name>ComStock 90.1-2007</display_name>
+        </choice>
+        <choice>
+          <value>ComStock 90.1-2010</value>
+          <display_name>ComStock 90.1-2010</display_name>
+        </choice>
+        <choice>
+          <value>ComStock 90.1-2013</value>
+          <display_name>ComStock 90.1-2013</display_name>
+        </choice>
       </choices>
     </argument>
     <argument>
       <name>check_eui_reasonableness</name>
       <display_name>EUI Reasonableness (General)</display_name>
-      <description>Check EUI for model against selected ASHRAE standard DOE prototype buildings.</description>
+      <description>Check model EUI against selected ASHRAE standard DOE prototype building.</description>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -77,7 +109,7 @@
     <argument>
       <name>check_eui_by_end_use</name>
       <display_name>End Use by Category (General)</display_name>
-      <description>Check end use by category against selected ASHRAE standard DOE prototype buildings.</description>
+      <description>Check model consumption by end use against selected ASHRAE standard DOE prototype building.</description>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -180,7 +212,7 @@
     <argument>
       <name>check_internal_loads</name>
       <display_name>Internal Loads (Baseline)</display_name>
-      <description>Check LPD, ventilation rates, occupant density, plug loads, and equipment loads against selected ASHRAE standard and DOE Prototype buildings.</description>
+      <description>Check LPD, ventilation rates, occupant density, plug loads, and equipment loads against selected ASHRAE standard DOE Prototype buildings.</description>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -319,7 +351,7 @@
     </argument>
     <argument>
       <name>check_mech_sys_type</name>
-      <display_name>Mechanical System Type (Baseline)</display_name>
+      <display_name>Baseline Mechanical System Type (Baseline)</display_name>
       <description>Check against ASHRAE 90.1. Infers the baseline system type based on the equipment serving the zone and their heating/cooling fuels. Only does a high-level inference; does not look for the presence/absence of required controls, etc.</description>
       <type>Boolean</type>
       <required>true</required>
@@ -364,6 +396,25 @@
       <model_dependent>false</model_dependent>
       <default_value>0.5</default_value>
     </argument>
+    <argument>
+      <name>use_upstream_args</name>
+      <display_name>Use Upstream Argument Values</display_name>
+      <description>When true this will look for arguments or registerValues in upstream measures that match arguments from this measure, and will use the value from the upstream measure in place of what is entered for this measure.</description>
+      <type>Boolean</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>true</default_value>
+      <choices>
+        <choice>
+          <value>true</value>
+          <display_name>true</display_name>
+        </choice>
+        <choice>
+          <value>false</value>
+          <display_name>false</display_name>
+        </choice>
+      </choices>
+    </argument>
   </arguments>
   <outputs />
   <provenances />
@@ -437,24 +488,12 @@
       <usage_type>resource</usage_type>
       <checksum>779C47A4</checksum>
     </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
-    </file>
     <file>
       <filename>BasicOfficeTest.osm</filename>
       <filetype>osm</filetype>
       <usage_type>test</usage_type>
       <checksum>75942985</checksum>
     </file>
-    <file>
-      <filename>MidRiseApt.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>146619F3</checksum>
-    </file>
     <file>
       <filename>BasicOfficeTest_Mueller_altHVAC_a.osm</filename>
       <filetype>osm</filetype>
@@ -491,12 +530,6 @@
       <usage_type>license</usage_type>
       <checksum>A21A3ED2</checksum>
     </file>
-    <file>
-      <filename>check_mech_sys_type.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>887B8C81</checksum>
-    </file>
     <file>
       <filename>check_plant_cap.rb</filename>
       <filetype>rb</filetype>
@@ -516,165 +549,231 @@
       <checksum>F32BF92B</checksum>
     </file>
     <file>
-      <filename>check_supply_air_and_thermostat_temp_difference.rb</filename>
+      <filename>check_placeholder.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>A6C5D312</checksum>
+      <checksum>C9561EBD</checksum>
     </file>
     <file>
-      <filename>check_placeholder.rb</filename>
+      <filename>check_plenum_loads.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>C9561EBD</checksum>
+      <checksum>46981891</checksum>
     </file>
     <file>
-      <filename>check_mech_sys_part_load_eff.rb</filename>
+      <filename>check_sch_coord.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>511ECDBF</checksum>
+      <checksum>B17FFC25</checksum>
     </file>
     <file>
-      <filename>check_plenum_loads.rb</filename>
+      <filename>check_air_sys_temps.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>46981891</checksum>
+      <checksum>C76C4A0C</checksum>
     </file>
     <file>
-      <filename>os_lib_reporting_qaqc.rb</filename>
+      <filename>check_plant_temps.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>14402DF5</checksum>
+      <checksum>A659EBCD</checksum>
     </file>
     <file>
-      <filename>check_schedules.rb</filename>
+      <filename>check_pump_pwr.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>97D9A3D1</checksum>
+      <checksum>4B6EC8EA</checksum>
     </file>
     <file>
-      <filename>check_simultaneous_heating_and_cooling.rb</filename>
+      <filename>check_weather_files.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>D8E9263B</checksum>
+      <checksum>85CA2E26</checksum>
     </file>
     <file>
-      <filename>check_sch_coord.rb</filename>
+      <filename>check_calibration.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>B17FFC25</checksum>
+      <checksum>8D1854A4</checksum>
     </file>
     <file>
-      <filename>check_eui_reasonableness.rb</filename>
+      <filename>CreateResults.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>83D17D6A</checksum>
+      <checksum>D38441F3</checksum>
     </file>
     <file>
-      <filename>check_internal_loads.rb</filename>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>3AFCE991</checksum>
+    </file>
+    <file>
+      <filename>generic_qaqc_summary.jpg</filename>
+      <filetype>jpg</filetype>
+      <usage_type>doc</usage_type>
+      <checksum>45ABEE68</checksum>
+    </file>
+    <file>
+      <filename>generic_qaqc_detailed.jpg</filename>
+      <filetype>jpg</filetype>
+      <usage_type>doc</usage_type>
+      <checksum>92EA3F5C</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.0.0</identifier>
+        <min_compatible>3.1.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>F698CF14</checksum>
+      <usage_type>script</usage_type>
+      <checksum>9482E15C</checksum>
     </file>
     <file>
-      <filename>check_domestic_hot_water.rb</filename>
+      <filename>fsr.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>D2A4E538</checksum>
+    </file>
+    <file>
+      <filename>uo_blend.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>605CDF17</checksum>
+    </file>
+    <file>
+      <filename>uo_strip_mall.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>95EBB09E</checksum>
+    </file>
+    <file>
+      <filename>uo_lg_hotel.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>B8033381</checksum>
+    </file>
+    <file>
+      <filename>USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw</filename>
+      <filetype>epw</filetype>
+      <usage_type>test</usage_type>
+      <checksum>6B50E0FF</checksum>
+    </file>
+    <file>
+      <filename>uo_mixed.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>1874C555</checksum>
+    </file>
+    <file>
+      <filename>check_mech_sys_type.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>E4F0F677</checksum>
+      <checksum>2B4C8CB1</checksum>
     </file>
     <file>
-      <filename>check_air_sys_temps.rb</filename>
+      <filename>check_supply_air_and_thermostat_temp_difference.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>C76C4A0C</checksum>
+      <checksum>245963C6</checksum>
     </file>
     <file>
-      <filename>check_cond_zns.rb</filename>
+      <filename>check_simultaneous_heating_and_cooling.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>7BCF4D51</checksum>
+      <checksum>FAEFC26D</checksum>
     </file>
     <file>
-      <filename>check_mech_sys_capacity.rb</filename>
+      <filename>check_cond_zns.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>776376DA</checksum>
+      <checksum>35AF3348</checksum>
     </file>
     <file>
-      <filename>check_plant_temps.rb</filename>
+      <filename>check_mech_sys_capacity.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>A659EBCD</checksum>
+      <checksum>D4C11C12</checksum>
     </file>
     <file>
-      <filename>check_pump_pwr.rb</filename>
+      <filename>check_mech_sys_efficiency.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>4B6EC8EA</checksum>
+      <checksum>5239DDEA</checksum>
     </file>
     <file>
-      <filename>check_weather_files.rb</filename>
+      <filename>check_schedules.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>85CA2E26</checksum>
+      <checksum>4381DA3F</checksum>
     </file>
     <file>
-      <filename>check_calibration.rb</filename>
+      <filename>check_internal_loads.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>8D1854A4</checksum>
+      <checksum>8770A7D0</checksum>
     </file>
     <file>
-      <filename>check_mech_sys_efficiency.rb</filename>
+      <filename>check_domestic_hot_water.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>F897A40B</checksum>
+      <checksum>43606255</checksum>
     </file>
     <file>
-      <filename>CreateResults.rb</filename>
+      <filename>check_mech_sys_part_load_eff.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>D38441F3</checksum>
+      <checksum>87A54A27</checksum>
     </file>
     <file>
-      <filename>measure_Test.rb</filename>
+      <filename>os_lib_reporting_qaqc.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>F46F0EA0</checksum>
+      <usage_type>resource</usage_type>
+      <checksum>579D7C6B</checksum>
     </file>
     <file>
-      <filename>check_eui_by_end_use.rb</filename>
+      <filename>check_eui_reasonableness.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>F188B64A</checksum>
+      <checksum>E6A6A3EB</checksum>
     </file>
     <file>
-      <filename>check_envelope_conductance.rb</filename>
+      <filename>check_eui_by_end_use.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>243DDE18</checksum>
+      <checksum>3CB3F8D4</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>BBC2D3D5</checksum>
+      <checksum>11DDEADA</checksum>
     </file>
     <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>2.0.0</identifier>
-        <min_compatible>3.1.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
+      <filename>measure_Test.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>6DD4E3C2</checksum>
+      <usage_type>test</usage_type>
+      <checksum>EA00F910</checksum>
+    </file>
+    <file>
+      <filename>MidRiseApt.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>8316418F</checksum>
+    </file>
+    <file>
+      <filename>check_envelope_conductance.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>3346FDCD</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>612E9631</checksum>
+      <checksum>1C5120F7</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/generic_qaqc/resources/check_cond_zns.rb

@@ -41,7 +41,9 @@ module OsLib_QAQC
     check_elems << OpenStudio::Attribute.new('name', 'Conditioned Zones')
     check_elems << OpenStudio::Attribute.new('category', category)
     check_elems << OpenStudio::Attribute.new('description', 'Check that all zones with people have thermostats.')
-
+    check_elems << OpenStudio::Attribute.new('min_pass', "#{(min_pass * 100).round(0)}")
+    check_elems << OpenStudio::Attribute.new('max_pass', "#{(max_pass * 100).round(0)}")
+    
     # stop here if only name is requested this is used to populate display name for arguments
     if name_only == true
       results = []

data/lib/measures/generic_qaqc/resources/check_domestic_hot_water.rb

@@ -49,11 +49,14 @@ module OsLib_QAQC
     else
       check_elems << OpenStudio::Attribute.new('description', 'Check against the 2011 ASHRAE Handbook - HVAC Applications, Table 7 section 50.14.')
     end
-
+    check_elems << OpenStudio::Attribute.new('min_pass', min_pass * 100)
+    check_elems << OpenStudio::Attribute.new('max_pass', max_pass * 100)
+    
     # stop here if only name is requested this is used to populate display name for arguments
     if name_only == true
       results = []
       check_elems.each do |elem|
+        next if ['Double','Integer'].include? (elem.valueType.valueDescription)
         results << elem.valueAsString
       end
       return results
@@ -158,7 +161,7 @@ module OsLib_QAQC
 
               space_type_num_people_hours = 0.0
               # loop through peole instances
-              space_type.peoples.each do |inst|
+              space_type.people.each do |inst|
                 inst_num_people = inst.getNumberOfPeople(space_type_floor_area)
                 inst_schedule = inst.numberofPeopleSchedule.get # sim will fail prior to this if doesn't have it
 
@@ -185,7 +188,7 @@ module OsLib_QAQC
 
               num_people_hours += space_type_num_people_hours
             end
-            num_meals = num_people_hours / 365.0 * 1.5 # 90 minute meal
+            num_meals = num_people_hours / (365.0 * 1.5) # 90 minute meal
             target_consumption = num_meals * ashrae_hot_water_demand.first[:avg_day_unit]
 
           elsif ['LargeHotel', 'SmallHotel'].include? building_type
@@ -287,7 +290,7 @@ module OsLib_QAQC
 
               num_people_hours += space_type_num_people_hours
             end
-            num_meals = num_people_hours / 365.0 * 0.5 # 30 minute leal
+            num_meals = num_people_hours / (365.0 * 0.5) # 30 minute leal
             # todo - add logic to address drive through traffic
             target_consumption = num_meals * ashrae_hot_water_demand.first[:avg_day_unit]
 
@@ -312,10 +315,12 @@ module OsLib_QAQC
       end
 
       # check actual against target
-      if service_water_consumption_daily_avg_gal < target_consumption * (1.0 - min_pass)
-        check_elems <<  OpenStudio::Attribute.new('flag', "Annual average of #{service_water_consumption_daily_avg_gal.round} gallons per day of hot water is more than #{min_pass * 100} % below the expected value of #{target_consumption.round} gallons per day.")
-      elsif service_water_consumption_daily_avg_gal > target_consumption * (1.0 + max_pass)
-        check_elems <<  OpenStudio::Attribute.new('flag', "Annual average of #{service_water_consumption_daily_avg_gal.round} gallons per day of hot water is more than #{max_pass * 100} % above the expected value of #{target_consumption.round} gallons per day.")
+      if !target_consumption.nil?
+        if service_water_consumption_daily_avg_gal < target_consumption * (1.0 - min_pass)
+          check_elems <<  OpenStudio::Attribute.new('flag', "Annual average of #{service_water_consumption_daily_avg_gal.round} gallons per day of hot water is more than #{min_pass * 100} % below the value of #{target_consumption.round} gallons per day.")
+        elsif service_water_consumption_daily_avg_gal > target_consumption * (1.0 + max_pass)
+          check_elems <<  OpenStudio::Attribute.new('flag', "Annual average of #{service_water_consumption_daily_avg_gal.round} gallons per day of hot water is more than #{max_pass * 100} % above the value of #{target_consumption.round} gallons per day.")
+        end
       end
     rescue StandardError => e
       # brief description of ruby error