openstudio-common-measures 0.9.0 → 0.11.0

data/lib/measures/envelope_and_internal_load_breakdown/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>envelope_and_internal_load_breakdown</name>
   <uid>8f0e1fbb-8bc6-46e5-b6e4-db59177e2c02</uid>
-  <version_id>094a25e3-d116-401e-8cdb-ae076a79079a</version_id>
-  <version_modified>20221115T224203Z</version_modified>
+  <version_id>094afbcf-e319-4ed7-8521-61c153d3883e</version_id>
+  <version_modified>2024-11-16T23:54:14Z</version_modified>
   <xml_checksum>69BA4D91</xml_checksum>
   <class_name>EnvelopeAndInternalLoadBreakdown</class_name>
   <display_name>Envelope and Internal Load Breakdown</display_name>
@@ -71,28 +71,22 @@
   </attributes>
   <files>
     <file>
-      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
-      <filetype>epw</filetype>
-      <usage_type>test</usage_type>
-      <checksum>BDF687C1</checksum>
-    </file>
-    <file>
-      <filename>ExampleModel.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>7F9DACF4</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>8696A072</checksum>
     </file>
     <file>
-      <filename>ExampleModel_NoExtNoGround.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>07CE0378</checksum>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>7D00FFF0</checksum>
     </file>
     <file>
-      <filename>ExampleModel_NoLoads_NoOA.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>CA6A593D</checksum>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>1223C55C</checksum>
     </file>
     <file>
       <filename>htg_gain_detailed_a.png</filename>
@@ -113,63 +107,69 @@
       <checksum>E8E7FBC8</checksum>
     </file>
     <file>
-      <filename>htg_loss_summary.png</filename>
+      <filename>htg_loss_detailed.png</filename>
       <filetype>png</filetype>
       <usage_type>doc</usage_type>
-      <checksum>69DDA02E</checksum>
+      <checksum>6E4E8FE2</checksum>
     </file>
     <file>
-      <filename>htg_loss_detailed.png</filename>
+      <filename>htg_loss_summary.png</filename>
       <filetype>png</filetype>
       <usage_type>doc</usage_type>
-      <checksum>6E4E8FE2</checksum>
+      <checksum>69DDA02E</checksum>
     </file>
     <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>1223C55C</checksum>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.0.0</identifier>
+        <min_compatible>3.8.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>184F527B</checksum>
     </file>
     <file>
       <filename>os_lib_reporting_envelope_and_internal_loads_breakdown.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>471E57CB</checksum>
+      <checksum>EBC3D1C1</checksum>
     </file>
     <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
+      <filename>report.html.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>41C02D76</checksum>
     </file>
     <file>
       <filename>EnvelopeAndInternalLoadBreakdown_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>C9C97ADF</checksum>
+      <checksum>DCE6255F</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>script</usage_type>
-      <checksum>4B3CF7A8</checksum>
+      <filename>ExampleModel.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>7F9DACF4</checksum>
     </file>
     <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>7D00FFF0</checksum>
+      <filename>ExampleModel_NoExtNoGround.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>07CE0378</checksum>
     </file>
     <file>
-      <filename>report.html.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>0C9A88EB</checksum>
+      <filename>ExampleModel_NoLoads_NoOA.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>CA6A593D</checksum>
+    </file>
+    <file>
+      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
+      <filetype>epw</filetype>
+      <usage_type>test</usage_type>
+      <checksum>BDF687C1</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/envelope_and_internal_load_breakdown/resources/report.html.erb

@@ -23,6 +23,7 @@
 
 
 
+
 
 <!DOCTYPE html>
 <html lang="en">

data/lib/measures/example_report/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/example_report/measure.rb

@@ -6,10 +6,6 @@
 require 'erb'
 require 'json'
 
-# load OpenStudio measure libraries from openstudio-extension gem
-require 'openstudio-extension'
-require 'openstudio/extension/core/os_lib_helper_methods'
-
 require "#{File.dirname(__FILE__)}/resources/os_lib_reporting_example"
 
 # start the measure
@@ -88,7 +84,8 @@ class ExampleReport < OpenStudio::Measure::ReportingMeasure
     web_asset_path = setup[:web_asset_path]
 
     # assign the user inputs to variables
-    args = OsLib_HelperMethods.createRunVariables(runner, model, user_arguments, arguments)
+    args = runner.getArgumentValues(arguments, user_arguments)
+    args = Hash[args.collect{ |k, v| [k.to_s, v] }]
     unless args
       return false
     end

data/lib/measures/example_report/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>example_report</name>
   <uid>174a6f71-3e8c-4f99-9e7a-b64f2e7535d4</uid>
-  <version_id>7a62653c-c1e8-4550-a21f-3655bded5074</version_id>
-  <version_modified>20221115T224157Z</version_modified>
+  <version_id>efe8b2e1-1e99-41e1-beaa-523ce62763bc</version_id>
+  <version_modified>2024-11-16T23:54:10Z</version_modified>
   <xml_checksum>557BF06F</xml_checksum>
   <class_name>ExampleReport</class_name>
   <display_name>Example Report</display_name>
@@ -105,22 +105,16 @@
   </attributes>
   <files>
     <file>
-      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
-      <filetype>epw</filetype>
-      <usage_type>test</usage_type>
-      <checksum>BDF687C1</checksum>
-    </file>
-    <file>
-      <filename>ExampleModel.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>7F9DACF4</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>8696A072</checksum>
     </file>
     <file>
-      <filename>ExampleReport.pdf</filename>
-      <filetype>pdf</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>FBA35C89</checksum>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>3C0851D8</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -129,45 +123,51 @@
       <checksum>703C9964</checksum>
     </file>
     <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>3C0851D8</checksum>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.0.0</identifier>
+        <min_compatible>3.8.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>3E43ABFD</checksum>
+    </file>
+    <file>
+      <filename>ExampleReport.pdf</filename>
+      <filetype>pdf</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>FBA35C89</checksum>
     </file>
     <file>
       <filename>os_lib_reporting_example.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>79453AA9</checksum>
+      <checksum>44033BD8</checksum>
     </file>
     <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
+      <filename>report.html.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>FF1CBF19</checksum>
     </file>
     <file>
-      <filename>ExampleReport_Test.rb</filename>
-      <filetype>rb</filetype>
+      <filename>ExampleModel.osm</filename>
+      <filetype>osm</filetype>
       <usage_type>test</usage_type>
-      <checksum>45DFAE69</checksum>
+      <checksum>7F9DACF4</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>ExampleReport_Test.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>04DFD4D1</checksum>
+      <usage_type>test</usage_type>
+      <checksum>5926CEE0</checksum>
     </file>
     <file>
-      <filename>report.html.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>71EF0A45</checksum>
+      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
+      <filetype>epw</filetype>
+      <usage_type>test</usage_type>
+      <checksum>BDF687C1</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/example_report/resources/report.html.erb

@@ -23,6 +23,7 @@
 
 
 
+
 
 
 <!DOCTYPE html>

data/lib/measures/gem_env_report/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/gem_env_report/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>gem_environment_report</name>
   <uid>3f9f1a2f-0e8a-4c88-b817-10494fc3e73a</uid>
-  <version_id>c37f64ba-bdf4-4c67-a5e6-4cd01086ac36</version_id>
-  <version_modified>20221115T223606Z</version_modified>
+  <version_id>cec906d1-dd78-4e27-b916-ea9b6384a1e8</version_id>
+  <version_modified>2024-11-16T23:54:17Z</version_modified>
   <xml_checksum>D1F10311</xml_checksum>
   <class_name>GemEnvironmentReport</class_name>
   <display_name>gem environment report</display_name>
@@ -40,10 +40,10 @@
   </attributes>
   <files>
     <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>8696A072</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -52,51 +52,51 @@
       <checksum>ACC6F66B</checksum>
     </file>
     <file>
-      <filename>run_gem_env_info.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>EB1D95F2</checksum>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
     </file>
     <file>
-      <filename>run_openstudio_info.rb</filename>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.0.0</identifier>
+        <min_compatible>2.0.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>926943DC</checksum>
+      <usage_type>script</usage_type>
+      <checksum>509760B0</checksum>
     </file>
     <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
+      <filename>gem_env_info.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>C74C9A12</checksum>
     </file>
     <file>
       <filename>openstudio_info.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>BA1249C5</checksum>
+      <checksum>58061348</checksum>
     </file>
     <file>
-      <filename>gem_env_info.rb</filename>
+      <filename>run_gem_env_info.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>5C631590</checksum>
+      <checksum>9F90BABF</checksum>
     </file>
     <file>
-      <filename>gem_env_report_Test.rb</filename>
+      <filename>run_openstudio_info.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>96AADEF6</checksum>
+      <usage_type>resource</usage_type>
+      <checksum>E4901393</checksum>
     </file>
     <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>2.0.0</identifier>
-        <min_compatible>2.0.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
+      <filename>gem_env_report_Test.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>3D133192</checksum>
+      <usage_type>test</usage_type>
+      <checksum>1F849B2D</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/generic_qaqc/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/generic_qaqc/README.md

@@ -27,38 +27,6 @@ This used to set the target standard for most checks.
 **Required:** true,
 **Model Dependent:** false
 
-### EUI Reasonableness (General)
-Check model EUI against selected ASHRAE standard DOE prototype building.
-**Name:** check_eui_reasonableness,
-**Type:** Boolean,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### EUI Reasonableness Tolerance
-
-**Name:** check_eui_reasonableness_tol,
-**Type:** Double,
-**Units:** fraction,
-**Required:** true,
-**Model Dependent:** false
-
-### End Use by Category (General)
-Check model consumption by end use against selected ASHRAE standard DOE prototype building.
-**Name:** check_eui_by_end_use,
-**Type:** Boolean,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### End Use by Category Tolerance
-
-**Name:** check_eui_by_end_use_tol,
-**Type:** Double,
-**Units:** fraction,
-**Required:** true,
-**Model Dependent:** false
-
 ### Mechanical System Part Load Efficiency (General)
 Check 40% and 80% part load efficency against selected ASHRAE standard for the following compenent types: ChillerElectricEIR, CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilHeatingDXSingleSpeed. Checking EIR Function of Part Load Ratio curve for chiller and EIR Function of Flow Fraction for DX coils.
 **Name:** check_mech_sys_part_load_eff,

data/lib/measures/generic_qaqc/measure.rb

@@ -7,24 +7,14 @@ require 'erb'
 require 'json'
 require 'openstudio-standards'
 
-# load OpenStudio measure libraries from openstudio-extension gem
-require 'openstudio-extension'
-require 'openstudio/extension/core/os_lib_schedules'
-require 'openstudio/extension/core/os_lib_helper_methods'
-require 'openstudio/extension/core/os_lib_model_generation.rb'
-
 # require all .rb files in resources folder
+# todo - remove resource ruby files and connect to OpenstudioStandards::QAQC
 Dir[File.dirname(__FILE__) + '/resources/*.rb'].each { |file| require file }
 
 # start the measure
 class GenericQAQC < OpenStudio::Measure::ReportingMeasure
   # all QAQC checks should be in OsLib_QAQC module
   include OsLib_QAQC
-  include OsLib_HelperMethods
-  include OsLib_ModelGeneration
-
-  # OsLib_CreateResults is needed for utility EDA programs but not the generic QAQC measure
-  # include OsLib_CreateResults
 
   # define the name that a user will see, this method may be deprecated as
   # the display name in PAT comes from the name field in measure.xml
@@ -71,8 +61,11 @@ class GenericQAQC < OpenStudio::Measure::ReportingMeasure
     options_check_mech_sys_capacity['zone_heating_capacity'] = { 'target' => 12.5, 'min' => 0.20, 'max' => 0.40, 'units' => 'Btu/ft^2*h' }
 
     # results << {:method_name => 'check_weather_files',:cat => 'General',:standards => false,:data => options_check_weather_files,:min_tol => false,:max_tol => false, :units => nil}
-    results << { method_name: 'check_eui_reasonableness', cat: 'General', standards: true, data: nil, tol_min: 0.1, tol_max: true, units: 'fraction' }
-    results << { method_name: 'check_eui_by_end_use', cat: 'General', standards: true, data: nil, tol_min: 0.25, tol_max: true, units: 'fraction' }
+    
+    # not reporting EUI and end use comparison until update to use newer methods in standards
+    #results << { method_name: 'check_eui_reasonableness', cat: 'General', standards: true, data: nil, tol_min: 0.1, tol_max: true, units: 'fraction' }
+    #results << { method_name: 'check_eui_by_end_use', cat: 'General', standards: true, data: nil, tol_min: 0.25, tol_max: true, units: 'fraction' }
+    
     results << { method_name: 'check_mech_sys_part_load_eff', cat: 'General', standards: true, data: nil, tol_min: 0.05, tol_max: true, units: 'fraction' }
     results << { method_name: 'check_mech_sys_capacity', cat: 'General', standards: true, data: options_check_mech_sys_capacity, tol_min: false, tol_max: false, units: 'fraction' }
     results << { method_name: 'check_simultaneous_heating_and_cooling', cat: 'General', standards: false, data: nil, tol_min: false, tol_max: 0.05, units: 'fraction' }
@@ -92,7 +85,7 @@ class GenericQAQC < OpenStudio::Measure::ReportingMeasure
     args = OpenStudio::Measure::OSArgumentVector.new
 
     # Make an argument for the template
-    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', get_doe_templates(false), true)
+    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', OpenstudioStandards::CreateTypical.get_doe_templates(false), true)
     template.setDisplayName('Target ASHRAE Standard')
     template.setDescription('This used to set the target standard for most checks.')
     template.setDefaultValue('90.1-2013') # there is override variable in run method for this
@@ -169,7 +162,8 @@ class GenericQAQC < OpenStudio::Measure::ReportingMeasure
     result = OpenStudio::IdfObjectVector.new
 
     # assign the user inputs to variables
-    args = OsLib_HelperMethods.createRunVariables(runner, @model, user_arguments, arguments)
+    args = runner.getArgumentValues(arguments, user_arguments)
+    args = Hash[args.collect{ |k, v| [k.to_s, v] }]
     unless args
       return false
     end
@@ -231,7 +225,8 @@ class GenericQAQC < OpenStudio::Measure::ReportingMeasure
     climateZones.setClimateZone('ASHRAE', cz)
 
     # assign the user inputs to variables
-    args = OsLib_HelperMethods.createRunVariables(runner, @model, user_arguments, arguments)
+    args = runner.getArgumentValues(arguments, user_arguments)
+    args = Hash[args.collect{ |k, v| [k.to_s, v] }]
     unless args
       return false
     end
@@ -246,7 +241,8 @@ class GenericQAQC < OpenStudio::Measure::ReportingMeasure
     if args['use_upstream_args'] == true
       args.each do |arg, value|
         next if arg == 'use_upstream_args' # this argument should not be changed
-        value_from_osw = OsLib_HelperMethods.check_upstream_measure_for_arg(runner, arg)
+        value_from_osw = runner.getPastStepValuesForName(arg)
+        value_from_osw = value_from_osw.collect{ |k, v| Hash[:measure_name => k, :value => v] }.first if !value_from_osw.empty?
         if !value_from_osw.empty?
           runner.registerInfo("Replacing argument named #{arg} from current measure with a value of #{value_from_osw[:value]} from #{value_from_osw[:measure_name]}.")
           new_val = value_from_osw[:value]