openstudio-common-measures 0.4.0 → 0.6.1

data/lib/measures/add_ev_load/measure.rb

@@ -98,10 +98,16 @@ class AddEVLoad < OpenStudio::Measure::ModelMeasure
     # Make an argument for the % of vehicles parked at the building that are EVs.
     ev_percent = OpenStudio::Measure::OSArgument.makeDoubleArgument('ev_percent', true)
     ev_percent.setDisplayName('Percent of Vehicles Parked at Building That Are EVs')
-    ev_percent.setDefaultValue(1.0)
+    ev_percent.setDefaultValue(100)
     ev_percent.setDescription('Denotes percentage of vehicles between 0 to 100 that are electric on site.')
     args << ev_percent
 
+    # Make an argument for using occupancy from OpenStudio Model.
+    ev_use_model_occupancy = OpenStudio::Measure::OSArgument.makeBoolArgument('ev_use_model_occupancy', true)
+    ev_use_model_occupancy.setDisplayName('Use occupancy from OpenStudio Model to determine number of electric vehicles')
+    ev_use_model_occupancy.setDefaultValue(true)
+    args << ev_use_model_occupancy
+
     return args
   end
 
@@ -114,6 +120,7 @@ class AddEVLoad < OpenStudio::Measure::ModelMeasure
     charge_behavior = runner.getStringArgumentValue('charge_behavior', user_arguments)
     chg_station_type = runner.getStringArgumentValue('chg_station_type', user_arguments)
     ev_percent = runner.getDoubleArgumentValue('ev_percent', user_arguments)
+    ev_use_model_occupancy = runner.getBoolArgumentValue('ev_use_model_occupancy', user_arguments)
 
     # use the built-in error checking
     if !runner.validateUserArguments(arguments(model), user_arguments)
@@ -155,13 +162,24 @@ class AddEVLoad < OpenStudio::Measure::ModelMeasure
     # Sets key based on charging station type, for general charging load profiles. Will use this to average columns appropriately.
     if chg_station_type == 'Typical Home'
       chg_station_key = 1
+      runner.registerInfo("charge station type = #{chg_station_type}")
       runner.registerInfo("charge station key = #{chg_station_key}")
+      # Assumed occupancy density is the typical occupancy density for charging station type determined by using a weighted
+      # average of building type and associated occupancy density 
+      assumed_occupancy_density = 0.003
+      runner.registerInfo("assumed occupancy = #{assumed_occupancy_density}")
     elsif chg_station_type == 'Typical Work'
       chg_station_key = 2
+      runner.registerInfo("charge station type = #{chg_station_type}")
       runner.registerInfo("charge station key = #{chg_station_key}")
+      assumed_occupancy_density = 0.005
+      runner.registerInfo("assumed occupancy = #{assumed_occupancy_density}")
     elsif chg_station_type == 'Typical Public'
       chg_station_key = 3
+      runner.registerInfo("charge station type = #{chg_station_type}")
       runner.registerInfo("charge station key = #{chg_station_key}")
+      assumed_occupancy_density = 0.0226
+      runner.registerInfo("assumed occupancy = #{assumed_occupancy_density}")
     end
 
     # Creating a schedule:ruleset
@@ -210,13 +228,26 @@ class AddEVLoad < OpenStudio::Measure::ModelMeasure
       indices = public_indices
     end
 
-    # Popualte the average weekday load for non PSN case. The load profiles used in this case are averaged based on the selected charging station type,(given the selected charging flexibility option and charging behavior option), and scaled for the percent of vehicles that are EVs.
+    space_type = model.getSpaceTypes[0]
+    model_occupancy = space_type.people.size
+    floor_area = space_type.floorArea
+    model_occupancy_density = space_type.getPeoplePerFloorArea(floor_area)
+    model_occupancy_density = model_occupancy_density/10.76 # Convert to people per ft2
+
+    # Populate the average weekday load for non PSN case. The load profiles used in this case are averaged based on the selected charging station type,(given the selected charging flexibility option and charging behavior option), and scaled for the percent of vehicles that are EVs.
     if chg_station_type != 'Pena Station Next Analysis' && chg_station_type != 'Pena Station Next Analysis--DC Fast Charger'
       wkday_load_sel = wkday_load.values_at(*indices)
       avg_load_wkday = []
       wkday_load_sel = wkday_load_sel.transpose
-      for i in 0..wkday_load[0].length - 1
-        avg_load_wkday[i] = (wkday_load_sel[i].reduce(0, :+) / wkday_load_sel[i].length) * ev_percent / assumed_percent # Scale profiles generated from 50% EV scenario by % of vehicles that are EVs.
+      if ev_use_model_occupancy
+        runner.registerInfo("model occupancy density = #{model_occupancy_density}")
+        for i in 0..wkday_load[0].length - 1
+          avg_load_wkday[i] = ((wkday_load_sel[i].reduce(0, :+) / wkday_load_sel[i].length) * ev_percent/assumed_percent) * (model_occupancy_density/assumed_occupancy_density) # Scale profiles generated from 50% EV scenario by occupancy of OpenStudio model (number of vehicles is assumed to be the same as occupancy of the building).
+        end
+      else
+        for i in 0..wkday_load[0].length - 1
+          avg_load_wkday[i] = (wkday_load_sel[i].reduce(0, :+) / wkday_load_sel[i].length) * ev_percent / assumed_percent # Scale profiles generated from 50% EV scenario by % of vehicles that are EVs.
+        end
       end
 
       wkday_max_load = avg_load_wkday.max
@@ -225,8 +256,14 @@ class AddEVLoad < OpenStudio::Measure::ModelMeasure
       sat_load_sel = sat_load.values_at(*indices)
       avg_load_sat = []
       sat_load_sel = sat_load_sel.transpose
-      for i in 0..sat_load[0].length - 1
-        avg_load_sat[i] = (sat_load_sel[i].reduce(0, :+) / sat_load_sel[i].length) * ev_percent / assumed_percent # Scale profiles generated from 50% EV scenario by % of vehicles that are EVs.
+      if ev_use_model_occupancy
+        for i in 0..sat_load[0].length - 1
+          avg_load_sat[i] = ((sat_load_sel[i].reduce(0, :+) / sat_load_sel[i].length) * ev_percent / assumed_percent) * (model_occupancy_density/assumed_occupancy_density) # Scale profiles generated from 50% EV scenario by occupancy of OpenStudio model and apply ev_percent (number of vehicles is assumed to be the same as occupancy of the building).
+        end
+      else
+        for i in 0..sat_load[0].length - 1
+          avg_load_sat[i] = (sat_load_sel[i].reduce(0, :+) / sat_load_sel[i].length) * ev_percent / assumed_percent # Scale profiles generated from 50% EV scenario by % of vehicles that are EVs.
+        end
       end
 
       sat_max_load = avg_load_sat.max
@@ -235,8 +272,14 @@ class AddEVLoad < OpenStudio::Measure::ModelMeasure
       sun_load_sel = sun_load.values_at(*indices)
       avg_load_sun = []
       sun_load_sel = sun_load_sel.transpose
-      for i in 0..sun_load[0].length - 1
-        avg_load_sun[i] = (sun_load_sel[i].reduce(0, :+) / sun_load_sel[i].length) * ev_percent / assumed_percent # Scale profiles generated from 50% EV scenario by % of vehicles that are EVs.
+      if ev_use_model_occupancy
+        for i in 0..sun_load[0].length - 1
+          avg_load_sun[i] = ((sun_load_sel[i].reduce(0, :+) / sun_load_sel[i].length) * ev_percent / assumed_percent) * (model_occupancy_density/assumed_occupancy_density) # Scale profiles generated from 50% EV scenario by occupancy of OpenStudio model and apply ev_percent (number of vehicles is assumed to be the same as occupancy of the building).
+        end
+      else
+        for i in 0..sun_load[0].length - 1
+          avg_load_sun[i] = (sun_load_sel[i].reduce(0, :+) / sun_load_sel[i].length) * ev_percent / assumed_percent # Scale profiles generated from 50% EV scenario by % of vehicles that are EVs.
+        end
       end
 
       sun_max_load = avg_load_sun.max

data/lib/measures/add_ev_load/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>add_ev_load</name>
   <uid>a23e0493-7357-48ca-b089-4d902efd6b50</uid>
-  <version_id>90476d7d-d880-4ce4-ada0-5dad10a82954</version_id>
-  <version_modified>20210406T224047Z</version_modified>
+  <version_id>5ef19868-80da-424d-9907-00e8bbd9919a</version_id>
+  <version_modified>20220505T194724Z</version_modified>
   <xml_checksum>9A202986</xml_checksum>
   <class_name>AddEVLoad</class_name>
   <display_name>Add_EV_Load</display_name>
@@ -86,7 +86,25 @@
       <type>Double</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>1</default_value>
+      <default_value>100</default_value>
+    </argument>
+    <argument>
+      <name>ev_use_model_occupancy</name>
+      <display_name>Use occupancy from OpenStudio Model to determine number of electric vehicles</display_name>
+      <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 />
@@ -331,7 +349,7 @@
       <filename>add_ev_load_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>5E255354</checksum>
+      <checksum>54550A66</checksum>
     </file>
     <file>
       <version>
@@ -342,7 +360,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>93A1C055</checksum>
+      <checksum>0F479CB4</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/envelope_and_internal_load_breakdown/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>envelope_and_internal_load_breakdown</name>
   <uid>8f0e1fbb-8bc6-46e5-b6e4-db59177e2c02</uid>
-  <version_id>682db2ce-3ce6-4536-92ed-d38b7f310919</version_id>
-  <version_modified>20210423T144509Z</version_modified>
+  <version_id>2ff096f8-c72d-444a-a56e-f0633fba2013</version_id>
+  <version_modified>20220622T165903Z</version_modified>
   <xml_checksum>69BA4D91</xml_checksum>
   <class_name>EnvelopeAndInternalLoadBreakdown</class_name>
   <display_name>Envelope and Internal Load Breakdown</display_name>
@@ -139,7 +139,7 @@
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>177CA671</checksum>
+      <checksum>6F54D1FE</checksum>
     </file>
   </files>
 </measure>

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

@@ -1,6 +1,6 @@
 <%
   # *******************************************************************************
-  # OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+  # OpenStudio(R), Copyright (c) 2008-2022, 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:
@@ -41,6 +41,11 @@
 
 
 
+
+
+
+
+
 <!DOCTYPE html>
 <html lang="en">
 <head>

data/lib/measures/example_report/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>example_report</name>
   <uid>174a6f71-3e8c-4f99-9e7a-b64f2e7535d4</uid>
-  <version_id>1d1f4225-bfba-4673-b81d-0ed9e7e769c5</version_id>
-  <version_modified>20210423T144518Z</version_modified>
+  <version_id>69180469-2020-4295-b159-80a548ad4c5c</version_id>
+  <version_modified>20220622T165857Z</version_modified>
   <xml_checksum>557BF06F</xml_checksum>
   <class_name>ExampleReport</class_name>
   <display_name>Example Report</display_name>
@@ -167,7 +167,7 @@
       <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/example_report/resources/report.html.erb

@@ -1,6 +1,6 @@
 <%
   # *******************************************************************************
-  # OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+  # OpenStudio(R), Copyright (c) 2008-2022, 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:
@@ -42,6 +42,11 @@
 
 
 
+
+
+
+
+
 <!DOCTYPE html>
 <html lang="en">
 <head>

data/lib/measures/generic_qaqc/README.md

@@ -28,7 +28,7 @@ This used to set the target standard for most checks.
 **Model Dependent:** false
 
 ### EUI Reasonableness (General)
-Check EUI for model against selected ASHRAE standard DOE prototype buildings.
+Check model EUI against selected ASHRAE standard DOE prototype building.
 **Name:** check_eui_reasonableness,
 **Type:** Boolean,
 **Units:** ,
@@ -44,7 +44,7 @@ Check EUI for model against selected ASHRAE standard DOE prototype buildings.
 **Model Dependent:** false
 
 ### End Use by Category (General)
-Check end use by category against selected ASHRAE standard DOE prototype buildings.
+Check model consumption by end use against selected ASHRAE standard DOE prototype building.
 **Name:** check_eui_by_end_use,
 **Type:** Boolean,
 **Units:** ,
@@ -100,7 +100,7 @@ Check for simultaneous heating and cooling by looping through all Single Duct VA
 **Model Dependent:** false
 
 ### Internal Loads (Baseline)
-Check LPD, ventilation rates, occupant density, plug loads, and equipment loads against selected ASHRAE standard and DOE Prototype buildings.
+Check LPD, ventilation rates, occupant density, plug loads, and equipment loads against selected ASHRAE standard DOE Prototype buildings.
 **Name:** check_internal_loads,
 **Type:** Boolean,
 **Units:** ,
@@ -179,7 +179,7 @@ Check against selected ASHRAE standard for the following component types: Chille
 **Required:** true,
 **Model Dependent:** false
 
-### Mechanical System Type (Baseline)
+### Baseline Mechanical System Type (Baseline)
 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.
 **Name:** check_mech_sys_type,
 **Type:** Boolean,
@@ -203,6 +203,21 @@ Check if fans modeled to ASHRAE 90.1 2013 Section G3.1.2.9 requirements. Compare
 **Required:** true,
 **Model Dependent:** false
 
+### Use Upstream Argument Values
+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.
+**Name:** use_upstream_args,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+
+
 
 
+## Screenshot of Sample Summary Table
+![Summary Table](./docs/generic_qaqc_summary.jpg?raw=true)
 
+## Screenshot of Sample Detailed Table  
+![Detailed Table](./docs/generic_qaqc_detailed.jpg?raw=true)

data/lib/measures/generic_qaqc/README.md.erb

@@ -39,4 +39,10 @@
 <% output_names << output[:display_name] %>
 <% end %>
 <%= output_names.join(", ") %>
-<% end %>
+<% end %>
+
+## Screenshot of Sample Summary Table
+![Summary Table](./docs/generic_qaqc_summary.jpg?raw=true)
+
+## Screenshot of Sample Detailed Table  
+![Detailed Table](./docs/generic_qaqc_detailed.jpg?raw=true)

data/lib/measures/generic_qaqc/measure.rb

@@ -41,6 +41,7 @@ require 'openstudio-standards'
 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
 Dir[File.dirname(__FILE__) + '/resources/*.rb'].each { |file| require file }
@@ -49,6 +50,9 @@ Dir[File.dirname(__FILE__) + '/resources/*.rb'].each { |file| require file }
 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
 
@@ -89,6 +93,7 @@ class GenericQAQC < OpenStudio::Measure::ReportingMeasure
 
     # gather inputs for check_mech_sys_capacity. Each option has a target value, min and max fractional tolerance, and units
     # in the future climate zone specific targets may be in standards
+    # todo - expose these tollerances as user arguments
     options_check_mech_sys_capacity = {}
     options_check_mech_sys_capacity['chiller_max_flow_rate'] = { 'target' => 2.4, 'min' => 0.1, 'max' => 0.1, 'units' => 'gal/ton*min' }
     options_check_mech_sys_capacity['air_loop_max_flow_rate'] = { 'target' => 1.0, 'min' => 0.1, 'max' => 0.1, 'units' => 'cfm/ft^2' }
@@ -117,14 +122,7 @@ class GenericQAQC < OpenStudio::Measure::ReportingMeasure
     args = OpenStudio::Measure::OSArgumentVector.new
 
     # Make an argument for the template
-    template_chs = OpenStudio::StringVector.new
-    template_chs << 'DOE Ref Pre-1980'
-    template_chs << 'DOE Ref 1980-2004'
-    template_chs << '90.1-2004'
-    template_chs << '90.1-2007'
-    template_chs << '90.1-2010'
-    template_chs << '90.1-2013'
-    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', template_chs, true)
+    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', 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
@@ -184,6 +182,13 @@ class GenericQAQC < OpenStudio::Measure::ReportingMeasure
       end
     end
 
+    # make an argument for use_upstream_args
+    use_upstream_args = OpenStudio::Measure::OSArgument.makeBoolArgument('use_upstream_args', true)
+    use_upstream_args.setDisplayName('Use Upstream Argument Values')
+    use_upstream_args.setDescription('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.')
+    use_upstream_args.setDefaultValue(true)
+    args << use_upstream_args
+
     return args
   end # end the arguments method
 
@@ -267,32 +272,32 @@ class GenericQAQC < OpenStudio::Measure::ReportingMeasure
     # used for edapt programs to populate xml file with extra data
     # report_elems << create_results
 
-    # utility name to to used by some qaqc checks
-    @utility_name = nil # for utility QAQC string is passed in
-    default_target_standard = args['template'] # for utility QAQC this is hard coded, for generic it is user argument
-
-    # for large scale analysis may want to infer this from building name so it will be in sync with template variables from earlier measures
-    override_template_arg = false
-    if override_template_arg
-      template_chs = []
-      template_chs << 'DOE Ref Pre-1980'
-      template_chs << 'DOE Ref 1980-2004'
-      template_chs << '90.1-2004'
-      template_chs << '90.1-2007'
-      template_chs << '90.1-2010'
-      template_chs << '90.1-2013'
-      # map standard
-      template_chs.each do |template_ch|
-        if @model.getBuilding.name.to_s.include?(template_ch)
-          default_target_standard = template_ch
-          if template_ch != args['template']
-            runner.registerInfo("override_template_arg is true. Ignoring user argument of #{args['template']} and instead using #{template_ch}.")
+    # lookup and replace argument values from upstream measures
+    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)
+        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]
+          # TODO: - make code to handle non strings more robust. check_upstream_measure_for_arg coudl pass bakc the argument type
+          if arg == 'total_bldg_floor_area'
+            args[arg] = new_val.to_f
+          elsif arg == 'num_stories_above_grade'
+            args[arg] = new_val.to_f
+          elsif arg == 'zipcode'
+            args[arg] = new_val.to_i
+          else
+            args[arg] = new_val
           end
-          break
         end
       end
     end
 
+    # utility name to to used by some qaqc checks
+    @utility_name = nil # for utility QAQC string is passed in
+    default_target_standard = args['template'] # for utility QAQC this is hard coded, for generic it is user argument
+
     # get building type, different standards path if multifamily
     building_type = ''
     if @model.getBuilding.standardsBuildingType.is_initialized