openstudio-common-measures 0.2.1 → 0.3.0

data/lib/measures/create_variable_speed_rtu/measure.xml

@@ -0,0 +1,207 @@
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>create_variable_speed_rtu</name>
+  <uid>7fb36b3a-5591-4627-a2b0-7709fbeae593</uid>
+  <version_id>b4784727-b8f2-46e2-92ad-219ecd2e1c5a</version_id>
+  <version_modified>20200229T024317Z</version_modified>
+  <xml_checksum>A9D5932A</xml_checksum>
+  <class_name>CreateVariableSpeedRTU</class_name>
+  <display_name>Create Variable Speed RTU</display_name>
+  <description>This measure examines the existing HVAC system(s) present in the current OpenStudio model. If a constant-speed system is found, the user can opt to have the measure replace that system with a variable-speed RTU. 'Variable speed' in this case means that the compressor will be operated using either two or four stages (user's choice). The user can choose between using a gas heating coil, or a direct-expansion (DX) heating coil. Additionally, the user is able to enter the EER (cooling) and COP (heating) values for each DX stage. This measure allows users to easily identify the impact of improved part-load efficiency.</description>
+  <modeler_description>This measure loops through the existing airloops, looking for loops that have a constant speed fan. (Note that if an object such as an AirloopHVAC:UnitarySystem is present in the model, that the measure will NOT identify that loop as either constant- or variable-speed, since the fan is located inside the UnitarySystem object.) The user can designate which constant-speed airloop they'd like to apply the measure to, or opt to apply the measure to all airloops. The measure then replaces the supply components on the airloop with an AirloopHVAC:UnitarySystem object. Any DX coils added to the UnitarySystem object are of the type CoilCoolingDXMultiSpeed / CoilHeatingDXMultiSpeed, with the number of stages set to either two or four, depending on user input. If the user opts for a gas furnace, an 80% efficient CoilHeatingGas object is added. Fan properties (pressure rise and total efficiency) are transferred automatically from the existing (but deleted) constant speed fan to the new variable-speed fan. Currently, this measure is only applicable to the Standalone Retail DOE Prototype building model, but it has been structured to facilitate expansion to other models with a minimum of effort.</modeler_description>
+  <arguments>
+    <argument>
+      <name>object</name>
+      <display_name>Choose an Air Loop to change from CAV to VAV.</display_name>
+      <type>Choice</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>*All CAV Air Loops*</default_value>
+      <choices>
+        <choice>
+          <value>{42167619-c2eb-4812-a9e5-9b286d7beef8}</value>
+          <display_name>*All CAV Air Loops*</display_name>
+        </choice>
+      </choices>
+    </argument>
+    <argument>
+      <name>cooling_coil_type</name>
+      <display_name>Choose the type of cooling coil.</display_name>
+      <type>Choice</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>Two-Stage Compressor</default_value>
+      <choices>
+        <choice>
+          <value>Two-Stage Compressor</value>
+          <display_name>Two-Stage Compressor</display_name>
+        </choice>
+        <choice>
+          <value>Four-Stage Compressor</value>
+          <display_name>Four-Stage Compressor</display_name>
+        </choice>
+      </choices>
+    </argument>
+    <argument>
+      <name>rated_cc_eer</name>
+      <display_name>Rated Cooling Coil EER</display_name>
+      <type>Double</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>three_quarter_cc_eer</name>
+      <display_name>Cooling Coil EER at 75% Capacity</display_name>
+      <type>Double</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>half_cc_eer</name>
+      <display_name>Cooling Coil EER at 50% Capacity</display_name>
+      <type>Double</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>quarter_cc_eer</name>
+      <display_name>Cooling Coil EER at 25% Capacity</display_name>
+      <type>Double</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>heating_coil_type</name>
+      <display_name>Choose the type of heating coil.</display_name>
+      <type>Choice</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>Gas Heating Coil</default_value>
+      <choices>
+        <choice>
+          <value>Gas Heating Coil</value>
+          <display_name>Gas Heating Coil</display_name>
+        </choice>
+        <choice>
+          <value>Heat Pump</value>
+          <display_name>Heat Pump</display_name>
+        </choice>
+      </choices>
+    </argument>
+    <argument>
+      <name>rated_hc_gas_efficiency</name>
+      <display_name>Rated Gas Heating Coil Efficiency (0-1.00)</display_name>
+      <type>Double</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>rated_hc_cop</name>
+      <display_name>Rated Heating Coil COP</display_name>
+      <type>Double</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>three_quarter_hc_cop</name>
+      <display_name>Heating Coil COP at 75% Capacity</display_name>
+      <type>Double</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>half_hc_cop</name>
+      <display_name>Heating Coil COP at 50% Capacity</display_name>
+      <type>Double</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>quarter_hc_cop</name>
+      <display_name>Heating Coil COP at 25% Capacity</display_name>
+      <type>Double</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+  </arguments>
+  <outputs/>
+  <provenances/>
+  <tags>
+    <tag>HVAC.Whole System</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ModelMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Apply Measure Now</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>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Model Articulation</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>New Construction EE</value>
+      <datatype>string</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>example_model.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>69467654</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>839520ED</checksum>
+    </file>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>E0468DD6</checksum>
+    </file>
+    <file>
+      <filename>create_variable_speed_rtu_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>B199E2FA</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>1.12.2</identifier>
+        <min_compatible>2.7.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>13C7C1EA</checksum>
+    </file>
+  </files>
+</measure>

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>d5440237-cf84-4f6b-9369-611c253371a3</version_id>
-  <version_modified>20200623T192456Z</version_modified>
+  <version_id>0adab61f-9365-42cd-b6ab-ce548fafff91</version_id>
+  <version_modified>20201001T054735Z</version_modified>
   <xml_checksum>0A3BF61C</xml_checksum>
   <class_name>GenericQAQC</class_name>
   <display_name>Generic QAQC</display_name>
@@ -527,12 +527,6 @@
       <usage_type>resource</usage_type>
       <checksum>A46F04B4</checksum>
     </file>
-    <file>
-      <filename>check_eui_by_end_use.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>D81E33DD</checksum>
-    </file>
     <file>
       <filename>check_mech_sys_part_load_eff.rb</filename>
       <filetype>rb</filetype>
@@ -623,12 +617,6 @@
       <usage_type>resource</usage_type>
       <checksum>E3D75A8F</checksum>
     </file>
-    <file>
-      <filename>check_envelope_conductance.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>4F5626E2</checksum>
-    </file>
     <file>
       <filename>check_weather_files.rb</filename>
       <filetype>rb</filetype>
@@ -682,5 +670,17 @@
       <usage_type>resource</usage_type>
       <checksum>AD451814</checksum>
     </file>
+    <file>
+      <filename>check_eui_by_end_use.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>504C5330</checksum>
+    </file>
+    <file>
+      <filename>check_envelope_conductance.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>7814F60A</checksum>
+    </file>
   </files>
 </measure>

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

@@ -389,7 +389,13 @@ module OsLib_QAQC
               if use_old_gem_code
                 data = @model.get_construction_properties(target_standard, intended_surface_type, standards_construction_type)
               else
-                data = std.model_get_construction_properties(@model, intended_surface_type, standards_construction_type)
+
+                # model_get_construction_properties takes additional arguments now, maybe standard should update to add default
+                building_type = std.model_get_standards_building_type(@model)
+                construction_set_data = std.model_get_construction_set(building_type)
+                building_type_category = construction_set_data['exterior_wall_building_category']
+
+                data = std.model_get_construction_properties(@model, intended_surface_type, standards_construction_type, building_type_category)
               end
 
               if data.nil?

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

@@ -92,17 +92,16 @@ module OsLib_QAQC
       OpenStudio::EndUseCategoryType.getValues.each do |end_use|
         # get end uses
         end_use = OpenStudio::EndUseCategoryType.new(end_use).valueDescription
-        query_elec = "SELECT Value FROM tabulardatawithstrings WHERE ReportName='AnnualBuildingUtilityPerformanceSummary' and TableName='End Uses' and RowName= '#{end_use}' and ColumnName= 'Electricity'"
-        query_gas = "SELECT Value FROM tabulardatawithstrings WHERE ReportName='AnnualBuildingUtilityPerformanceSummary' and TableName='End Uses' and RowName= '#{end_use}' and ColumnName= 'Natural Gas'"
-        query_add = "SELECT Value FROM tabulardatawithstrings WHERE ReportName='AnnualBuildingUtilityPerformanceSummary' and TableName='End Uses' and RowName= '#{end_use}' and ColumnName= 'Additional Fuel'"
-        query_dc = "SELECT Value FROM tabulardatawithstrings WHERE ReportName='AnnualBuildingUtilityPerformanceSummary' and TableName='End Uses' and RowName= '#{end_use}' and ColumnName= 'District Cooling'"
-        query_dh = "SELECT Value FROM tabulardatawithstrings WHERE ReportName='AnnualBuildingUtilityPerformanceSummary' and TableName='End Uses' and RowName= '#{end_use}' and ColumnName= 'District Heating'"
-        results_elec = @sql.execAndReturnFirstDouble(query_elec).get
-        results_gas = @sql.execAndReturnFirstDouble(query_gas).get
-        results_add = @sql.execAndReturnFirstDouble(query_add).get
-        results_dc = @sql.execAndReturnFirstDouble(query_dc).get
-        results_dh = @sql.execAndReturnFirstDouble(query_dh).get
-        total_end_use = results_elec + results_gas + results_add + results_dc + results_dh
+
+        total_end_use = 0
+        OpenStudio::EndUseFuelType.getValues.each do |fuel_type|
+          # convert integer to string
+          fuel_name = OpenStudio::EndUseFuelType.new(fuel_type).valueDescription
+          next if fuel_name == 'Water'
+          query_fuel = "SELECT Value FROM tabulardatawithstrings WHERE ReportName='AnnualBuildingUtilityPerformanceSummary' and TableName='End Uses' and RowName= '#{end_use}' and ColumnName= '#{fuel_name}'"
+          results_fuel = @sql.execAndReturnFirstDouble(query_fuel).get
+          total_end_use += results_fuel
+        end
 
         # populate hash for actual end use normalized by area
         actual_eui_by_end_use[end_use] = total_end_use / energy_plus_area

data/lib/measures/openstudio_results/README.md

@@ -246,7 +246,11 @@ This argument does not effect HTML file, instead it makes data from individal ce
 
 
 
-electricity_ip, natural_gas_ip, additional_fuel_ip, district_heating_ip, district_cooling_ip, total_site_eui, eui, net_site_energy, annual_peak_electric_demand, unmet_hours_during_occupied_cooling, unmet_hours_during_occupied_heating, first_year_capital_cost, annual_utility_cost, total_lifecycle_cost
+
+
+
+
+electricity_ip, natural_gas_ip, additional_fuel_ip, district_heating_ip, district_cooling_ip, total_site_eui, eui, net_site_energy, annual_peak_electric_demand, unmet_hours_during_occupied_cooling, unmet_hours_during_occupied_heating, first_year_capital_cost, annual_utility_cost, total_lifecycle_cost, number_of_measures_with_warnings, number_warnings
 
 
 ## Contributors

data/lib/measures/openstudio_results/measure.rb

@@ -112,7 +112,7 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
     result << 'schedules_overview_section'
     # TODO: - clean up code to gather schedule profiles so I don't have to grab every 15 minutes
 
-    # TODO: - add in section to report warnings for this and other measures
+    # add in section to report warnings for this and other measures
     result << 'measure_warning_section'
 
     # see the method below in os_lib_reporting.rb to see a simple example of code to make a section of tables
@@ -182,10 +182,12 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
       category_str = OpenStudio::EndUseCategoryType.new(category_type).valueDescription
       category_strs << category_str
     end
-    additional_fuel_types = ['FuelOil#1', 'FuelOil#2', 'PropaneGas', 'Coal', 'Diesel', 'Gasoline', 'OtherFuel1', 'OtherFuel2']
+
+    additional_fuel_types = ['FuelOilNo1', 'FuelOilNo2', 'PropaneGas', 'Coal', 'Diesel', 'Gasoline', 'OtherFuel1', 'OtherFuel2']
+    # additional_fuel_types = OsLib_Reporting.fuel_type_names # getting all fuels instead of additional until fixed in OS
     additional_fuel_types.each do |additional_fuel_type|
       monthly_array = ['Output:Table:Monthly']
-      monthly_array << 'Building Energy Performance - FuelOil#1'
+      monthly_array << "Building Energy Performance - #{additional_fuel_type}"
       monthly_array << '2'
       category_strs.each do |category_string|
         monthly_array << "#{category_string}:#{additional_fuel_type}"
@@ -217,7 +219,9 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
     result << OpenStudio::Measure::OSOutput.makeDoubleOutput('annual_utility_cost') # $
     result << OpenStudio::Measure::OSOutput.makeDoubleOutput('total_lifecycle_cost') # $
 
-    # TODO: - add warning counts, but only if they will always be made.
+    # add warning counts
+    result << OpenStudio::Measure::OSOutput.makeDoubleOutput('number_of_measures_with_warnings')
+    result << OpenStudio::Measure::OSOutput.makeDoubleOutput('number_warnings')
 
     return result
   end
@@ -306,16 +310,16 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
       rescue StandardError => e
         display_name = eval("OsLib_Reporting.#{method_name}(nil,nil,nil,true)[:title]")
         if display_name.nil? then display_name == method_name end
-        runner.registerWarning("#{display_name} section failed and was skipped because: #{e}. Detail on error follows.")
-        runner.registerWarning(e.backtrace.join("\n").to_s)
+        runner.registerWarning("#{display_name} section failed and was skipped because: #{e}. Detail on error follows: #{e.backtrace.join("\n")}")
 
         # add in section heading with message if section fails
         section = {}
         section[:title] = display_name.to_s
         section[:tables] = []
         section[:messages] = []
-        section[:messages] << "#{display_name} section failed and was skipped because: #{e}. Detail on error follows."
-        section[:messages] << [e.backtrace.join("\n").to_s]
+        section[:messages] << "#{display_name} section failed and was skipped because: #{e}. Detail on error is in Measure Warnings section, if enabled at the bottom of this report."
+        # backtrace is now in Measure Warning section and doesn't need to be in line with the report section.
+        # section[:messages] << [e.backtrace.join("\n").to_s]
         @sections << section
       end
 

data/lib/measures/openstudio_results/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>openstudio_results</name>
   <uid>a25386cd-60e4-46bc-8b11-c755f379d916</uid>
-  <version_id>5d24f032-e2e4-407f-a20d-9f76e15d4ac1</version_id>
-  <version_modified>20200626T221404Z</version_modified>
+  <version_id>f0fd2916-1c52-4c78-bf00-25b7c5e5ca3a</version_id>
+  <version_modified>20201001T065500Z</version_modified>
   <xml_checksum>557BF06F</xml_checksum>
   <class_name>OpenStudioResults</class_name>
   <display_name>OpenStudio Results</display_name>
@@ -544,6 +544,20 @@
       <type>Double</type>
       <model_dependent>false</model_dependent>
     </output>
+    <output>
+      <name>number_of_measures_with_warnings</name>
+      <display_name>number_of_measures_with_warnings</display_name>
+      <short_name>number_of_measures_with_warnings</short_name>
+      <type>Double</type>
+      <model_dependent>false</model_dependent>
+    </output>
+    <output>
+      <name>number_warnings</name>
+      <display_name>number_warnings</display_name>
+      <short_name>number_warnings</short_name>
+      <type>Double</type>
+      <model_dependent>false</model_dependent>
+    </output>
   </outputs>
   <provenances />
   <tags>
@@ -606,12 +620,6 @@
       <usage_type>test</usage_type>
       <checksum>C62949E8</checksum>
     </file>
-    <file>
-      <filename>PeriodInConstName.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>D67C186D</checksum>
-    </file>
     <file>
       <filename>HeatingOnly.osm</filename>
       <filetype>osm</filetype>
@@ -630,18 +638,6 @@
       <usage_type>readmeerb</usage_type>
       <checksum>4F81E2EA</checksum>
     </file>
-    <file>
-      <filename>add_tariff.osw</filename>
-      <filetype>osw</filetype>
-      <usage_type>test</usage_type>
-      <checksum>1F52F669</checksum>
-    </file>
-    <file>
-      <filename>ExampleModel.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>F70DF221</checksum>
-    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
@@ -1392,12 +1388,6 @@
       <usage_type>resource</usage_type>
       <checksum>8A8CE353</checksum>
     </file>
-    <file>
-      <filename>OpenStudioResults_Test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>4DFBB60F</checksum>
-    </file>
     <file>
       <filename>Siz.HumidifierSteamElectric.rb</filename>
       <filetype>rb</filetype>
@@ -1434,34 +1424,64 @@
       <usage_type>resource</usage_type>
       <checksum>0169F9F8</checksum>
     </file>
-    <file>
-      <filename>os_lib_reporting.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>E15D2A3D</checksum>
-    </file>
     <file>
       <filename>os_lib_schedules.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
       <checksum>C82D00CC</checksum>
     </file>
+    <file>
+      <filename>PeriodInConstName.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>E41FBCFF</checksum>
+    </file>
+    <file>
+      <filename>add_tariff.osw</filename>
+      <filetype>osw</filetype>
+      <usage_type>test</usage_type>
+      <checksum>BF680A60</checksum>
+    </file>
+    <file>
+      <filename>os_results.osw</filename>
+      <filetype>osw</filetype>
+      <usage_type>test</usage_type>
+      <checksum>8BE06CC3</checksum>
+    </file>
+    <file>
+      <filename>ExampleModel.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>42C65747</checksum>
+    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
-        <identifier>3.0.0</identifier>
-        <min_compatible>3.0.0</min_compatible>
+        <identifier>3.1.0</identifier>
+        <min_compatible>3.1.0</min_compatible>
       </version>
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>CBB2420E</checksum>
+      <checksum>CD87DF6C</checksum>
+    </file>
+    <file>
+      <filename>OpenStudioResults_Test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>B7FB7EB7</checksum>
+    </file>
+    <file>
+      <filename>os_lib_reporting.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>4A5657AB</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>F7DEA5C8</checksum>
+      <checksum>42709140</checksum>
     </file>
   </files>
 </measure>