openstudio-common-measures 0.10.0 → 0.11.0

data/lib/measures/inject_idf_objects/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>inject_idf_objects</name>
   <uid>f567dfbc-d280-4d68-b061-019ab2630cd0</uid>
-  <version_id>fad67fa1-ef05-4eea-bb44-8552e20c1a4c</version_id>
-  <version_modified>2024-07-11T14:32:07Z</version_modified>
+  <version_id>44e9e977-bab2-45e3-af0b-a48301fd330b</version_id>
+  <version_modified>2024-11-16T23:54:16Z</version_modified>
   <xml_checksum>A8BAB05F</xml_checksum>
   <class_name>InjectIDFObjects</class_name>
   <display_name> Inject IDF Objects</display_name>
@@ -64,7 +64,7 @@ This measure works for when you just need to add new IDF objects. If you need to
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>BFFB1AA6</checksum>
+      <checksum>8696A072</checksum>
     </file>
     <file>
       <filename>README.md</filename>

data/lib/measures/openstudio_results/LICENSE.md

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

data/lib/measures/openstudio_results/README.md

@@ -19,8 +19,8 @@ ReportingMeasure
 ## Arguments
 
 
-### Which Unit System do you want to use?
-
+### Unit System
+IP = Inch Pound, SI = International System, OS = OpenStudio
 **Name:** units,
 **Type:** Choice,
 **Units:** ,
@@ -211,6 +211,14 @@ This argument does not effect HTML file, instead it makes data from individal ce
 **Required:** true,
 **Model Dependent:** false
 
+### Add EnergyPlus Summary Reports?
+
+**Name:** energyplus_reports,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
 
 
 

data/lib/measures/openstudio_results/measure.rb

@@ -98,8 +98,10 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
     chs = OpenStudio::StringVector.new
     chs << 'IP'
     chs << 'SI'
+    chs << 'OS'
     units = OpenStudio::Measure::OSArgument.makeChoiceArgument('units', chs, true)
-    units.setDisplayName('Which Unit System do you want to use?')
+    units.setDisplayName('Unit System')
+    units.setDescription('IP = Inch Pound, SI = International System, OS = OpenStudio')
     units.setDefaultValue('IP')
     args << units
 
@@ -121,6 +123,12 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
     reg_monthly_details.setDefaultValue(false) # set to false so no impact on existing projects using the measure
     args << reg_monthly_details
 
+    # add energyplus output tables, used by revit systems analysis
+    energyplus_reports = OpenStudio::Measure::OSArgument::makeBoolArgument('energyplus_reports', true)
+    energyplus_reports.setDisplayName('Add EnergyPlus Summary Reports?')
+    energyplus_reports.setDefaultValue(false)
+    args << energyplus_reports
+
     args
   end
 
@@ -210,15 +218,15 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
     # assign the user inputs to variables
     args = runner.getArgumentValues(arguments, user_arguments)
     args = Hash[args.collect{ |k, v| [k.to_s, v] }]
+    energyplus_reports = runner.getBoolArgumentValue('energyplus_reports', user_arguments)
     unless args
       return false
     end
+
+    # get units, runner's is used by revit systems analysis
     units = args['units']
-    if units == 'IP'
-      is_ip_units = true
-    else
-      is_ip_units = false
-    end
+    units = runner.unitsPreference if units == 'OS'
+    is_ip_units = units == 'IP' ? true : false
 
     # reporting final condition
     runner.registerInitialCondition("Gathering data from EnergyPlus SQL file and OSM model. Will report in #{units} Units")
@@ -314,10 +322,14 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
       html_in = file.read
     end
 
-    # configure template with variable values
+    # configure template with variable values, resources_path needed to find javascript web libraries for html
+    resources_path = "#{File.dirname(__FILE__)}/resources/"
     renderer = ERB.new(html_in)
     html_out = renderer.result(binding)
 
+    # add energyplus reports, used by revit systems analysis
+    html_out = OsLib_Reporting.add_energyplus_reports(runner, html_out) if energyplus_reports
+
     # write html file
     html_out_path = './report.html'
     File.open(html_out_path, 'w') do |file|

data/lib/measures/openstudio_results/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>openstudio_results</name>
   <uid>a25386cd-60e4-46bc-8b11-c755f379d916</uid>
-  <version_id>5b4d387a-f537-4693-a9eb-6192957b6c1b</version_id>
-  <version_modified>2024-07-11T14:31:57Z</version_modified>
+  <version_id>a70480c9-7dfa-42f7-9632-93f96baafc66</version_id>
+  <version_modified>2024-11-16T23:54:10Z</version_modified>
   <xml_checksum>557BF06F</xml_checksum>
   <class_name>OpenStudioResults</class_name>
   <display_name>OpenStudio Results</display_name>
@@ -13,7 +13,8 @@
   <arguments>
     <argument>
       <name>units</name>
-      <display_name>Which Unit System do you want to use?</display_name>
+      <display_name>Unit System</display_name>
+      <description>IP = Inch Pound, SI = International System, OS = OpenStudio</description>
       <type>Choice</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -27,6 +28,10 @@
           <value>SI</value>
           <display_name>SI</display_name>
         </choice>
+        <choice>
+          <value>OS</value>
+          <display_name>OS</display_name>
+        </choice>
       </choices>
     </argument>
     <argument>
@@ -444,6 +449,24 @@
         </choice>
       </choices>
     </argument>
+    <argument>
+      <name>energyplus_reports</name>
+      <display_name>Add EnergyPlus Summary Reports?</display_name>
+      <type>Boolean</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>false</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>
     <output>
@@ -600,13 +623,13 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>BFFB1AA6</checksum>
+      <checksum>8696A072</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>42709140</checksum>
+      <checksum>E0389149</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -623,13 +646,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>477BD96D</checksum>
+      <checksum>2D427F94</checksum>
     </file>
     <file>
       <filename>Siz.AirConditionerVariableRefrigerantFlow.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>BD293F43</checksum>
+      <checksum>6DA5E570</checksum>
     </file>
     <file>
       <filename>Siz.AirLoopHVAC.rb</filename>
@@ -767,25 +790,25 @@
       <filename>Siz.CoilCoolingDXMultiSpeed.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>F32E2FFA</checksum>
+      <checksum>BF0AD812</checksum>
     </file>
     <file>
       <filename>Siz.CoilCoolingDXMultiSpeedStageData.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>6CB99094</checksum>
+      <checksum>C58077B5</checksum>
     </file>
     <file>
       <filename>Siz.CoilCoolingDXSingleSpeed.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>3390D1A1</checksum>
+      <checksum>9C60D300</checksum>
     </file>
     <file>
       <filename>Siz.CoilCoolingDXTwoSpeed.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>4151B258</checksum>
+      <checksum>E513D800</checksum>
     </file>
     <file>
       <filename>Siz.CoilCoolingDXTwoStageWithHumidityControlMode.rb</filename>
@@ -827,13 +850,13 @@
       <filename>Siz.CoilCoolingWaterToAirHeatPumpEquationFit.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>03188BC3</checksum>
+      <checksum>DA146F1F</checksum>
     </file>
     <file>
       <filename>Siz.CoilCoolingWaterToAirHeatPumpVariableSpeedEquationFit.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>9DD25624</checksum>
+      <checksum>12947DE6</checksum>
     </file>
     <file>
       <filename>Siz.CoilCoolingWaterToAirHeatPumpVariableSpeedEquationFitSpeedData.rb</filename>
@@ -845,7 +868,7 @@
       <filename>Siz.CoilHeatingDXMultiSpeed.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>0BB9923F</checksum>
+      <checksum>59F3B220</checksum>
     </file>
     <file>
       <filename>Siz.CoilHeatingDXMultiSpeedStageData.rb</filename>
@@ -857,7 +880,7 @@
       <filename>Siz.CoilHeatingDXSingleSpeed.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>731CE022</checksum>
+      <checksum>063CB050</checksum>
     </file>
     <file>
       <filename>Siz.CoilHeatingDXVariableRefrigerantFlow.rb</filename>
@@ -935,13 +958,13 @@
       <filename>Siz.CoilHeatingWaterToAirHeatPumpEquationFit.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>04727BB3</checksum>
+      <checksum>74C06F43</checksum>
     </file>
     <file>
       <filename>Siz.CoilHeatingWaterToAirHeatPumpVariableSpeedEquationFit.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>CE732BD0</checksum>
+      <checksum>28BD9190</checksum>
     </file>
     <file>
       <filename>Siz.CoilHeatingWaterToAirHeatPumpVariableSpeedEquationFitSpeedData.rb</filename>
@@ -953,7 +976,7 @@
       <filename>Siz.CoilPerformanceDXCooling.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>5249A2FA</checksum>
+      <checksum>C971E88C</checksum>
     </file>
     <file>
       <filename>Siz.CoilSystemCoolingDXHeatExchangerAssisted.rb</filename>
@@ -1081,6 +1104,12 @@
       <usage_type>resource</usage_type>
       <checksum>2C4E2395</checksum>
     </file>
+    <file>
+      <filename>Siz.FanSystemModel.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>335E730E</checksum>
+    </file>
     <file>
       <filename>Siz.FanVariableVolume.rb</filename>
       <filetype>rb</filetype>
@@ -1187,7 +1216,7 @@
       <filename>Siz.Model.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>AED992B4</checksum>
+      <checksum>889D4393</checksum>
     </file>
     <file>
       <filename>Siz.ModelObject.rb</filename>
@@ -1393,17 +1422,47 @@
       <usage_type>resource</usage_type>
       <checksum>0F50F322</checksum>
     </file>
+    <file>
+      <filename>bootstrap.min.css</filename>
+      <filetype>css</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>2C33597B</checksum>
+    </file>
+    <file>
+      <filename>bootstrap.min.js</filename>
+      <filetype>js</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>3BFC4183</checksum>
+    </file>
+    <file>
+      <filename>d3.min.js</filename>
+      <filetype>js</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>EB90CCAC</checksum>
+    </file>
+    <file>
+      <filename>dimple.v2.1.2.min.js</filename>
+      <filetype>js</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>0F69C1CF</checksum>
+    </file>
+    <file>
+      <filename>jquery.min.js</filename>
+      <filetype>js</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>574D0600</checksum>
+    </file>
     <file>
       <filename>os_lib_reporting.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>2B4F256F</checksum>
+      <checksum>8DEAE75A</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>945F4BD1</checksum>
+      <checksum>3151B6DF</checksum>
     </file>
     <file>
       <filename>1004_SmallHotel_a.osm</filename>

data/lib/measures/openstudio_results/resources/Siz.AirConditionerVariableRefrigerantFlow.rb

@@ -76,7 +76,7 @@ class OpenStudio::Model::AirConditionerVariableRefrigerantFlow
     effs = []
     effs << [ratedCoolingCOP, 'Rated Cooling COP']
     effs << [ratedHeatingCOP, 'Rated Heating COP']
-    effs << [evaporativeCondenserEffectiveness, 'Evaporative Condenser Effectiveness']
+    effs << [evaporativeCondenserEffectiveness, 'Evaporative Condenser Effectiveness'] if condenserType == 'EvaporativelyCooled'
     return effs
   end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilCoolingDXMultiSpeed.rb

@@ -19,4 +19,14 @@ class OpenStudio::Model::CoilCoolingDXMultiSpeed
   def maxAirFlowRateAutosized
     stages.last.maxAirFlowRateAutosized
   end
+
+  def performanceCharacteristics
+    effs = []
+    stages.each_with_index do |stage_data, i|
+      stage_effs = stage_data.performanceCharacteristics
+      stage_effs.each{|pc| pc[1] = "Stage #{i+1} #{pc[1]}"}
+      effs.concat stage_effs
+    end
+    return effs
+  end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilCoolingDXMultiSpeedStageData.rb

@@ -41,7 +41,9 @@ class OpenStudio::Model::CoilCoolingDXMultiSpeedStageData
   def performanceCharacteristics
     effs = []
     effs << [grossRatedCoolingCOP, 'Gross Rated Cooling COP']
-    effs << [evaporativeCondenserEffectiveness, 'Evaporative Condenser Effectiveness']
+    if parentCoil.is_initialized
+      effs << [evaporativeCondenserEffectiveness, 'Evaporative Condenser Effectiveness'] if parentCoil.get.condenserType == 'EvaporativelyCooled'
+    end
     return effs
   end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilCoolingDXSingleSpeed.rb

@@ -40,8 +40,8 @@ class OpenStudio::Model::CoilCoolingDXSingleSpeed
 
   def performanceCharacteristics
     effs = []
-    effs << [ratedCOP, 'Rated COP']
-    effs << [evaporativeCondenserEffectiveness, 'Evaporative Condenser Effectiveness']
+    effs << [ratedCOP, 'Rated Cooling COP']
+    effs << [evaporativeCondenserEffectiveness, 'Evaporative Condenser Effectiveness'] if condenserType == 'EvaporativelyCooled'
     return effs
   end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilCoolingDXTwoSpeed.rb

@@ -42,8 +42,9 @@ class OpenStudio::Model::CoilCoolingDXTwoSpeed
     effs = []
     effs << [ratedHighSpeedCOP, 'Rated High Speed COP']
     effs << [ratedLowSpeedCOP, 'Rated Low Speed COP']
-    effs << [highSpeedEvaporativeCondenserEffectiveness, 'High Speed Evaporative Condenser Effectiveness']
-    effs << [lowSpeedEvaporativeCondenserEffectiveness, 'Low Speed Evaporative Condenser Effectiveness']
-    return effs
+    if condenserType == 'EvaporativelyCooled'
+      effs << [highSpeedEvaporativeCondenserEffectiveness, 'High Speed Evaporative Condenser Effectiveness']
+      effs << [lowSpeedEvaporativeCondenserEffectiveness, 'Low Speed Evaporative Condenser Effectiveness']
+    end
   end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilCoolingWaterToAirHeatPumpEquationFit.rb

@@ -54,4 +54,10 @@ class OpenStudio::Model::CoilCoolingWaterToAirHeatPumpEquationFit
       return OpenStudio::OptionalBool.new(true)
     end
   end
+
+  def performanceCharacteristics
+    effs = []
+    effs << [ratedCoolingCoefficientofPerformance, 'Rated Cooling COP']
+    return effs
+  end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilCoolingWaterToAirHeatPumpVariableSpeedEquationFit.rb

@@ -54,4 +54,14 @@ class OpenStudio::Model::CoilCoolingWaterToAirHeatPumpVariableSpeedEquationFit
       return OpenStudio::OptionalBool.new(true)
     end
   end
+
+  def performanceCharacteristics
+    effs = []
+    speeds.each_with_index do |speed_data, i|
+      speed_effs = speed_data.performanceCharacteristics
+      speed_effs.each { |pc| pc[1] = "Speed #{i+1} #{pc[1]}"}
+      effs.concat speed_effs
+    end
+    return effs
+  end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilHeatingDXMultiSpeed.rb

@@ -19,4 +19,14 @@ class OpenStudio::Model::CoilHeatingDXMultiSpeed
   def maxAirFlowRateAutosized
     stages.last.maxAirFlowRateAutosized
   end
+
+  def performanceCharacteristics
+    effs = []
+    stages.each_with_index do |stage_data, i|
+      stage_effs = stage_data.performanceCharacteristics
+      stage_effs.each{|pc| pc[1] = "Stage #{i+1} #{pc[1]}"}
+      effs.concat stage_effs
+    end
+    return effs
+  end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilHeatingDXSingleSpeed.rb

@@ -40,7 +40,7 @@ class OpenStudio::Model::CoilHeatingDXSingleSpeed
 
   def performanceCharacteristics
     effs = []
-    effs << [ratedCOP, 'Rated COP']
+    effs << [ratedCOP, 'Rated Heating COP']
     return effs
   end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilHeatingWaterToAirHeatPumpEquationFit.rb

@@ -54,4 +54,10 @@ class OpenStudio::Model::CoilHeatingWaterToAirHeatPumpEquationFit
       return OpenStudio::OptionalBool.new(true)
     end
   end
+
+  def performanceCharacteristics
+    effs = []
+    effs << [ratedHeatingCoefficientofPerformance, 'Rated Heating COP']
+    return effs
+  end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilHeatingWaterToAirHeatPumpVariableSpeedEquationFit.rb

@@ -54,4 +54,14 @@ class OpenStudio::Model::CoilHeatingWaterToAirHeatPumpVariableSpeedEquationFit
       return OpenStudio::OptionalBool.new(true)
     end
   end
+
+  def performanceCharacteristics
+    effs = []
+    speeds.each_with_index do |speed_data, i|
+      speed_effs = speed_data.performanceCharacteristics
+      speed_effs.each { |pc| pc[1] = "Speed #{i+1} #{pc[1]}"}
+      effs.concat speed_effs
+    end
+    return effs
+  end
 end

data/lib/measures/openstudio_results/resources/Siz.CoilPerformanceDXCooling.rb

@@ -41,7 +41,7 @@ class OpenStudio::Model::CoilPerformanceDXCooling
   def performanceCharacteristics
     effs = []
     effs << [grossRatedCoolingCOP, 'Gross Rated Cooling COP']
-    effs << [evaporativeCondenserEffectiveness, 'Evaporative Condenser Effectiveness']
+    effs << [evaporativeCondenserEffectiveness, 'Evaporative Condenser Effectiveness'] if condenserType == 'EvaporativelyCooled'
     return effs
   end
 end

data/lib/measures/openstudio_results/resources/Siz.FanSystemModel.rb

@@ -0,0 +1,31 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+class OpenStudio::Model::FanSystemModel
+  def maxAirFlowRate
+    if designMaximumFlowRate.is_initialized
+      designMaximumFlowRate
+    else
+      autosizedDesignMaximumFlowRate
+    end
+  end
+
+  def maxAirFlowRateAutosized
+    if designMaximumFlowRate.is_initialized
+      # Not autosized if hard size field value present
+      return OpenStudio::OptionalBool.new(false)
+    else
+      return OpenStudio::OptionalBool.new(true)
+    end
+  end
+
+  def performanceCharacteristics
+    effs = []
+    effs << [fanTotalEfficiency, 'Fan Total Efficiency']
+    effs << [designPressureRise, 'Design Pressure Rise']
+    effs << [motorEfficiency, 'Motor Efficiency']
+    return effs
+  end
+end

data/lib/measures/openstudio_results/resources/Siz.Model.rb

@@ -81,6 +81,7 @@ require_relative 'Siz.EvaporativeFluidCoolerSingleSpeed'
 require_relative 'Siz.EvaporativeFluidCoolerTwoSpeed'
 require_relative 'Siz.FanConstantVolume'
 require_relative 'Siz.FanOnOff'
+require_relative 'Siz.FanSystemModel'
 require_relative 'Siz.FanVariableVolume'
 require_relative 'Siz.FanZoneExhaust'
 require_relative 'Siz.FluidCoolerSingleSpeed'