openstudio-common-measures 0.2.0 → 0.4.0

data/lib/measures/UnmetLoadHoursTroubleshooting/measure.xml

@@ -3,22 +3,74 @@
   <schema_version>3.0</schema_version>
   <name>unmet_load_hours_troubleshooting</name>
   <uid>edf8fc3a-5607-4e0f-9dd2-4a1e1545433b</uid>
-  <version_id>b9d5c4d9-f049-4b5c-aed9-e4acc594856b</version_id>
-  <version_modified>20200509T041912Z</version_modified>
+  <version_id>e462b4b6-4c2d-4e08-9e71-b354e50b4df8</version_id>
+  <version_modified>20210406T220300Z</version_modified>
   <xml_checksum>5BFE84C4</xml_checksum>
   <class_name>UnmetLoadHoursTroubleshooting</class_name>
   <display_name>Unmet Load Hours Troubleshooting</display_name>
-  <description>Unmet load hours are any hours of operation when conditioned spaces are outside the throttling range for heating or cooling controls. That is, they are the hours in a year that the HVAC system serving a space cannot maintain space setpoint. This measure performs a series of checks against various model input variables and when applicable informs the user of possible sources of unmet cooling and heating hours. The measure also creates a dynamic time series plot of unmet cooling and heating hours, by zone - whose patterns may be interpreted to assist in troubleshooting unmet cooling and heating hours. Prior to running this measure, users will need to add the following output variables to their model: 1) Zone Mean Air Temperature,hourly  2) Zone Thermostat Heating Setpoint Temperature, hourly 3) Zone Thermostat Cooling Setpoint Temperature, hourly 4) Zone People Occupant Count, hourly using the AddOutputVariable OS measure, or the add output variables screen in the OpenStudio application.
+  <description>Unmet load hours are any hours of operation when conditioned spaces are outside the throttling range for heating or cooling controls. That is, they are the hours in a year that the HVAC system serving a space cannot maintain space setpoint. This measure performs a series of checks against various model input variables and when applicable informs the user of possible sources of unmet cooling and heating hours. The measure also creates a dynamic time series plot of unmet cooling and heating hours, by zone - whose patterns may be interpreted to assist in troubleshooting unmet cooling and heating hours. Prior to running this measure, users will need to add the following output variables to their model: 1) Zone Mean Air Temperature,hourly  2) Zone Thermostat Heating Setpoint Temperature, hourly 3) Zone Thermostat Cooling Setpoint Temperature, hourly 4) Zone People Occupant Count, hourly using the AddOutputVariable OS measure, or the add output variables screen in the OpenStudio application.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 </description>
-  <modeler_description>This measure performs a series of logic checks against model inputs for diagnosing common issues responsible for unmet cooling and heating hours. The measure will also create a time series interactive chart (using dygraph libraries) to provide a visual inspection of when unmet heating and cooling hours are occurring.
+  <modeler_description>This measure performs a series of logic checks against model inputs for diagnosing common issues responsible for unmet cooling and heating hours. The measure will also create a time series interactive chart (using dygraph libraries) to provide a visual inspection of when unmet heating and cooling hours are occurring.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
   </modeler_description>
   <arguments>
     <argument>
       <name>measure_zone</name>
       <display_name>Pick a Zone (or all Zones)</display_name>
-      <description></description>
       <type>Choice</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>All Zones</default_value>
@@ -28,8 +80,6 @@
           <display_name>All Zones</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
   </arguments>
   <outputs />
@@ -86,11 +136,23 @@
       <usage_type>readmeerb</usage_type>
       <checksum>703C9964</checksum>
     </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>5C03BFC2</checksum>
+    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>A21A3ED2</checksum>
+    </file>
+    <file>
+      <filename>UnmetLoadHoursTroubleshooting_Test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>D27C41EF</checksum>
     </file>
     <file>
       <version>
@@ -101,20 +163,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>3109FCD4</checksum>
-    </file>
-    <file>
-      <filename>UnmetLoadHoursTroubleshooting_Test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>0D74ED36</checksum>
-    </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>0B68E96D</checksum>
+      <checksum>775AD0E6</checksum>
     </file>
   </files>
 </measure>
-<error>wrong number of arguments (given 1, expected 0)</error>

data/lib/measures/VentilationQAQC/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted 
 provided that the following conditions are met:

data/lib/measures/VentilationQAQC/README.md

@@ -2,7 +2,7 @@
 
 ###### (Automatically generated documentation)
 
-# 
+# Ventilation Report
 
 ## Description
 
@@ -11,7 +11,7 @@
 
 
 ## Measure Type
-ModelMeasure
+ReportingMeasure
 
 ## Taxonomy
 
@@ -19,8 +19,14 @@ ModelMeasure
 ## Arguments
 
 
+### Pick a Zone (or all Zones)
+
+**Name:** measure_zone,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
 
 
-This measure does not have any user arguments
 
 

data/lib/measures/VentilationQAQC/measure.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -70,7 +70,7 @@ class VentilationQAQC < OpenStudio::Measure::ReportingMeasure
   #   note - there is no 'model' argument provided here.  This may cause an issue.
   #
 
-  def arguments
+  def arguments(model = nil)
     args = OpenStudio::Measure::OSArgumentVector.new
 
     # Future functionality
@@ -159,63 +159,70 @@ class VentilationQAQC < OpenStudio::Measure::ReportingMeasure
 
       zone_infiltration_vals = getTimeSeries('Zone Infiltration Air Change Rate', zone_name.upcase, annEnvPd, 'Hourly', runner)
 
-      puts('Get Occupant')
-
       zone_occupant_vals = getTimeSeries('Zone People Occupant Count', zone_name.upcase, annEnvPd, 'Hourly', runner)
       zone_occupant_max = !zone_occupant_vals.nil? ? zone_occupant_vals.max : 0
 
-      zone_occupant_normalized = zone_occupant_vals.map { |v| v / zone_occupant_max }
+      # stop here if zone_occupant_max is 0 is don't divide by 0 and catch zone_occupant_vals when nil before .map
+      if zone_occupant_max == 0
+        runner.registerInfo("Skipping #{zone_name}, can't noramlize occupancy with max of 0.")
+      else
+
+        zone_occupant_normalized = zone_occupant_vals.map { |v| v / zone_occupant_max }
 
-      unoccupied = 0
-      lightly_occupied = 0
+        unoccupied = 0
+        lightly_occupied = 0
 
-      coordinated = zone_occupant_normalized.zip(zone_mechanical_ventilation_vals)
+        coordinated = zone_occupant_normalized.zip(zone_mechanical_ventilation_vals)
 
-      coordinated.each do |vals|
-        normalized_occupancy = vals[0]
-        zone_mech_vent = vals[1]
+        coordinated.each do |vals|
+          normalized_occupancy = vals[0]
+          zone_mech_vent = vals[1]
 
-        if normalized_occupancy == 0 && zone_mech_vent > 0
-          unoccupied += 1
-        end
+          if normalized_occupancy == 0 && zone_mech_vent > 0
+            unoccupied += 1
+          end
 
-        if normalized_occupancy < 0.05 && zone_mech_vent > 20
-          lightly_occupied += 1
+          if normalized_occupancy < 0.05 && zone_mech_vent > 20
+            lightly_occupied += 1
+          end
         end
-      end
 
-      puts "Unoccupied: #{unoccupied}, Lightly Occupied: #{lightly_occupied}"
+        puts "Unoccupied: #{unoccupied}, Lightly Occupied: #{lightly_occupied}"
 
-      if unoccupied > 10
-        warnings.push("Thermal Zone <strong>#{zone_name}</strong> appears to have mechanical ventilation during periods when the zone is unoccupied, resulting in potentially unnecessary ventilation energy. This occurs <strong>#{unoccupied}</strong> hours per run period. Please ensure this is a correct representation of the modeling scenario. Minimum fraction OA schedules may need adjusting.")
-      end
+        if unoccupied > 10
+          warnings.push("Thermal Zone <strong>#{zone_name}</strong> appears to have mechanical ventilation during periods when the zone is unoccupied, resulting in potentially unnecessary ventilation energy. This occurs <strong>#{unoccupied}</strong> hours per run period. Please ensure this is a correct representation of the modeling scenario. Minimum fraction OA schedules may need adjusting.")
+        end
+
+        if lightly_occupied > 1500
+          warnings.push("Thermal Zone <strong>#{zone_name}</strong> appears to have mechanical ventilation during periods when the zone is lightly occupied, resulting in potentially unnecessary ventilation energy. This occurs <strong>#{lightly_occupied}</strong> hours per run period. Please ensure this is a correct representation of the modeling scenario.")
+        end
 
-      if lightly_occupied > 1500
-        warnings.push("Thermal Zone <strong>#{zone_name}</strong> appears to have mechanical ventilation during periods when the zone is lightly occupied, resulting in potentially unnecessary ventilation energy. This occurs <strong>#{lightly_occupied}</strong> hours per run period. Please ensure this is a correct representation of the modeling scenario.")
       end
 
-      times = getTimesForSeries('Zone People Occupant Count', zone_name.upcase, annEnvPd, 'Hourly', runner)
-      js_date_times = times.map { |t| to_JSTime(t) }
+      times = getTimesForSeries('Zone Infiltration Air Change Rate', zone_name.upcase, annEnvPd, 'Hourly', runner)
+      if !times.nil?
+        js_date_times = times.map { |t| to_JSTime(t) }
 
-      # Create an array of arrays [timestamp, zone_mechanical_ventilation_vals, zone_infiltration_vals]
-      if zone_infiltration_vals
-        hourly_vals = js_date_times.zip(zone_infiltration_vals)
-      else
-        hourly_vals = nil
-      end
+        # Create an array of arrays [timestamp, zone_mechanical_ventilation_vals, zone_infiltration_vals]
+        if zone_infiltration_vals
+          hourly_vals = js_date_times.zip(zone_infiltration_vals)
+        else
+          hourly_vals = nil
+        end
 
-      # Add the hourly load data to JSON for the report.html
-      graph = {}
-      graph['title'] = "#{zone_name} - Hourly Infiltration"
-      graph['xaxislabel'] = 'Time'
-      graph['yaxislabel'] = 'Infiltration (ACH)'
-      graph['labels'] = ['Date', 'Infiltration (ACH)']
-      graph['colors'] = ['#FF5050', '#0066FF']
-      graph['timeseries'] = hourly_vals
-
-      # This measure requires ruby 2.0.0 to create the JSON for the report graph
-      if RUBY_VERSION >= '2.0.0'
-        annualGraphData << graph
+        # Add the hourly load data to JSON for the report.html
+        graph = {}
+        graph['title'] = "#{zone_name} - Hourly Infiltration"
+        graph['xaxislabel'] = 'Time'
+        graph['yaxislabel'] = 'Infiltration (ACH)'
+        graph['labels'] = ['Date', 'Infiltration (ACH)']
+        graph['colors'] = ['#FF5050', '#0066FF']
+        graph['timeseries'] = hourly_vals
+
+        # This measure requires ruby 2.0.0 to create the JSON for the report graph
+        if RUBY_VERSION >= '2.0.0'
+          annualGraphData << graph
+        end
       end
 
       zoneMetrics = {}
@@ -236,10 +243,10 @@ class VentilationQAQC < OpenStudio::Measure::ReportingMeasure
           spec = space.designSpecificationOutdoorAir.get
 
           # spaceMetrics[:specMethod] = spec.outdoorAirMethod
-          spaceMetrics[:specOutdoorAirFlowperPerson] = spec.getOutdoorAirFlowperPerson.value
-          spaceMetrics[:specOutdoorAirFlowperFloorArea] = spec.getOutdoorAirFlowperFloorArea.value
+          spaceMetrics[:specOutdoorAirFlowperPerson] = spec.outdoorAirFlowperPerson
+          spaceMetrics[:specOutdoorAirFlowperFloorArea] = spec.outdoorAirFlowperFloorArea
           spaceMetrics[:specOutdoorAirFlowRate] = spec.outdoorAirFlowRate
-          spaceMetrics[:specOutdoorAirFlowAirChangesperHour] = spec.getOutdoorAirFlowAirChangesperHour.value
+          spaceMetrics[:specOutdoorAirFlowAirChangesperHour] = spec.outdoorAirFlowAirChangesperHour
 
           # Outdoor Air Method
           # Outdoor Air Flow per Person {m3/s-person}

data/lib/measures/VentilationQAQC/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>ventilation_qaqc</name>
   <uid>cb13be0e-88f6-494c-b3b1-dc748b42e205</uid>
-  <version_id>b2ac0143-5938-4a75-b97d-8a846324c93a</version_id>
-  <version_modified>20200509T041912Z</version_modified>
+  <version_id>d27e7357-1f80-4bf7-ad23-d1945f12a999</version_id>
+  <version_modified>20210406T224047Z</version_modified>
   <xml_checksum>2C8A3EEF</xml_checksum>
   <class_name>VentilationQAQC</class_name>
   <display_name>Ventilation Report</display_name>
@@ -14,9 +14,7 @@
     <argument>
       <name>measure_zone</name>
       <display_name>Pick a Zone (or all Zones)</display_name>
-      <description></description>
       <type>Choice</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>All Zones</default_value>
@@ -26,8 +24,6 @@
           <display_name>All Zones</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
   </arguments>
   <outputs />
@@ -48,18 +44,6 @@
     </attribute>
   </attributes>
   <files>
-    <file>
-      <filename>ExampleModel.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>4E11CF11</checksum>
-    </file>
-    <file>
-      <filename>report.html.in</filename>
-      <filetype>in</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>E5A4911E</checksum>
-    </file>
     <file>
       <filename>USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw</filename>
       <filetype>epw</filetype>
@@ -72,11 +56,29 @@
       <usage_type>readmeerb</usage_type>
       <checksum>703C9964</checksum>
     </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>7A7F2C94</checksum>
+    </file>
+    <file>
+      <filename>small_office.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>358253AE</checksum>
+    </file>
+    <file>
+      <filename>report.html.in</filename>
+      <filetype>in</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>E5A4911E</checksum>
+    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>A21A3ED2</checksum>
     </file>
     <file>
       <version>
@@ -87,20 +89,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>318C6E15</checksum>
+      <checksum>0AD86D10</checksum>
     </file>
     <file>
-      <filename>VentilationQAQC_Test.rb</filename>
+      <filename>ventilation_qaqc_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>B2AE57AC</checksum>
-    </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>0B68E96D</checksum>
+      <checksum>AEA00AC7</checksum>
     </file>
   </files>
 </measure>
-<error>wrong number of arguments (given 1, expected 0)</error>

data/lib/measures/ZoneReport/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted 
 provided that the following conditions are met:

data/lib/measures/ZoneReport/README.md

@@ -2,7 +2,7 @@
 
 ###### (Automatically generated documentation)
 
-# 
+# Zone Report
 
 ## Description
 
@@ -11,7 +11,7 @@
 
 
 ## Measure Type
-ModelMeasure
+ReportingMeasure
 
 ## Taxonomy
 

data/lib/measures/ZoneReport/measure.rb

@@ -1,6 +1,6 @@
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -46,7 +46,7 @@ class ZoneReport < OpenStudio::Measure::ReportingMeasure
   end
 
   # define the arguments that the user will input
-  def arguments
+  def arguments(model = nil)
     args = OpenStudio::Measure::OSArgumentVector.new
     return args
   end