openstudio-extension 0.1.0 → 0.1.1

data/lib/openstudio/extension/core/check_eui_by_end_use.rb

@@ -0,0 +1,162 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2019, 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:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+module OsLib_QAQC
+  # include any general notes about QAQC method here
+
+  # checks the number of unmet hours in the model
+  def check_eui_by_end_use(category, target_standard, min_pass, max_pass, name_only = false)
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'End Use by Category')
+    check_elems << OpenStudio::Attribute.new('category', category)
+    check_elems << OpenStudio::Attribute.new('description', "Check end use by category against #{target_standard} DOE prototype buildings.")
+
+    # stop here if only name is requested this is used to populate display name for arguments
+    if name_only == true
+      results = []
+      check_elems.each do |elem|
+        results << elem.valueAsString
+      end
+      return results
+    end
+
+    # Versions of OpenStudio greater than 2.4.0 use a modified version of
+    # openstudio-standards with different method calls.  These methods
+    # require a "Standard" object instead of the standard being passed into method calls.
+    # This Standard object is used throughout the QAQC check.
+    if OpenStudio::VersionString.new(OpenStudio.openStudioVersion) < OpenStudio::VersionString.new('2.4.3')
+      use_old_gem_code = true
+    else
+      use_old_gem_code = false
+      std = Standard.build(target_standard)
+    end
+
+    begin
+      # total building area
+      query = 'SELECT Value FROM tabulardatawithstrings WHERE '
+      query << "ReportName='AnnualBuildingUtilityPerformanceSummary' and "
+      query << "ReportForString='Entire Facility' and "
+      query << "TableName='Building Area' and "
+      query << "RowName='Total Building Area' and "
+      query << "ColumnName='Area' and "
+      query << "Units='m2';"
+      query_results = @sql.execAndReturnFirstDouble(query)
+      if query_results.empty?
+        check_elems << OpenStudio::Attribute.new('flag', "Can't calculate EUI, SQL query for building area failed.")
+        return OpenStudio::Attribute.new('check', check_elems)
+      else
+        energy_plus_area = query_results.get
+      end
+
+      # temp code to check OS vs. E+ area
+      open_studio_area = @model.getBuilding.floorArea
+      if (energy_plus_area - open_studio_area).abs >= 0.1
+        check_elems << OpenStudio::Attribute.new('flag', "EnergyPlus reported area is #{energy_plus_area} (m^2). OpenStudio reported area is #{@model.getBuilding.floorArea} (m^2).")
+      end
+
+      # loop through end uses and gather consumption, normalized by floor area
+      actual_eui_by_end_use = {}
+      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
+
+        # populate hash for actual end use normalized by area
+        actual_eui_by_end_use[end_use] = total_end_use / energy_plus_area
+      end
+
+      # gather target end uses for given standard as hash
+      if use_old_gem_code
+        target_eui_by_end_use = @model.find_target_eui_by_end_use(target_standard)
+      else
+        std = Standard.build(target_standard)
+        target_eui_by_end_use = std.model_find_target_eui_by_end_use(@model)
+      end
+
+      # units for flag display text and unit conversion
+      source_units = 'GJ/m^2'
+      target_units = 'kBtu/ft^2'
+
+      # check acutal vs. target against tolerance
+      if !target_eui_by_end_use.nil?
+        actual_eui_by_end_use.each do |end_use, value|
+          # this should have value of 0 in model. This page change in the future. It doesn't exist in target lookup
+          next if end_use == 'Exterior Equipment'
+
+          # perform check and issue flags as needed
+          target_value = target_eui_by_end_use[end_use]
+          eui_ip_neat = OpenStudio.toNeatString(OpenStudio.convert(value, source_units, target_units).get, 5, true)
+          target_eui_ip_neat = OpenStudio.toNeatString(OpenStudio.convert(target_value, source_units, target_units).get, 1, true)
+
+          # add in use case specific logic to skip checks when near 0 actual and target
+          skip = false
+          if (end_use == 'Heat Recovery') && (value < 0.05) && (target_value < 0.05) then skip = true end
+          if (end_use == 'Pumps') && (value < 0.05) && (target_value < 0.05) then skip = true end
+
+          if (value < target_value * (1.0 - min_pass)) && !skip
+            check_elems << OpenStudio::Attribute.new('flag', "#{end_use} EUI of #{eui_ip_neat} (#{target_units}) is less than #{min_pass * 100} % below the expected #{end_use} EUI of #{target_eui_ip_neat} (#{target_units}) for #{target_standard}.")
+          elsif (value > target_value * (1.0 + max_pass)) && !skip
+            check_elems << OpenStudio::Attribute.new('flag', "#{end_use} EUI of #{eui_ip_neat} (#{target_units}) is more than #{max_pass * 100} % above the expected #{end_use} EUI of #{target_eui_ip_neat} (#{target_units}) for #{target_standard}.")
+          end
+        end
+      else
+        check_elems << OpenStudio::Attribute.new('flag', "Can't calculate target end use EUIs. Make sure model has expected climate zone and building type.")
+      end
+    rescue StandardError => e
+      # brief description of ruby error
+      check_elems << OpenStudio::Attribute.new('flag', "Error prevented QAQC check from running (#{e}).")
+
+      # backtrace of ruby error for diagnostic use
+      if @error_backtrace then check_elems << OpenStudio::Attribute.new('flag', e.backtrace.join("\n").to_s) end
+    end
+
+    # add check_elms to new attribute
+    check_elem = OpenStudio::Attribute.new('check', check_elems)
+
+    return check_elem
+    # note: registerWarning and registerValue will be added for checks downstream using os_lib_reporting_qaqc.rb
+  end
+end

data/lib/openstudio/extension/core/check_eui_reasonableness.rb

@@ -0,0 +1,135 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2019, 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:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+module OsLib_QAQC
+  # include any general notes about QAQC method here
+
+  # checks the number of unmet hours in the model
+  def check_eui_reasonableness(category, target_standard, min_pass, max_pass, name_only = false)
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'EUI Reasonableness')
+    check_elems << OpenStudio::Attribute.new('category', category)
+    check_elems << OpenStudio::Attribute.new('description', "Check EUI for model against #{target_standard} DOE prototype buildings.")
+
+    # stop here if only name is requested this is used to populate display name for arguments
+    if name_only == true
+      results = []
+      check_elems.each do |elem|
+        results << elem.valueAsString
+      end
+      return results
+    end
+
+    # Versions of OpenStudio greater than 2.4.0 use a modified version of
+    # openstudio-standards with different method calls.  These methods
+    # require a "Standard" object instead of the standard being passed into method calls.
+    # This Standard object is used throughout the QAQC check.
+    if OpenStudio::VersionString.new(OpenStudio.openStudioVersion) < OpenStudio::VersionString.new('2.4.3')
+      use_old_gem_code = true
+    else
+      use_old_gem_code = false
+      std = Standard.build(target_standard)
+    end
+
+    begin
+      # total building area
+      query = 'SELECT Value FROM tabulardatawithstrings WHERE '
+      query << "ReportName='AnnualBuildingUtilityPerformanceSummary' and "
+      query << "ReportForString='Entire Facility' and "
+      query << "TableName='Building Area' and "
+      query << "RowName='Total Building Area' and "
+      query << "ColumnName='Area' and "
+      query << "Units='m2';"
+      query_results = @sql.execAndReturnFirstDouble(query)
+      if query_results.empty?
+        check_elems << OpenStudio::Attribute.new('flag', "Can't calculate EUI, SQL query for building area failed.")
+        return OpenStudio::Attribute.new('check', check_elems)
+      else
+        energy_plus_area = query_results.get
+      end
+
+      # temp code to check OS vs. E+ area
+      open_studio_area = @model.getBuilding.floorArea
+      if (energy_plus_area - open_studio_area).abs >= 0.1
+        check_elems << OpenStudio::Attribute.new('flag', "EnergyPlus reported area is #{energy_plus_area} (m^2). OpenStudio reported area is #{@model.getBuilding.floorArea} (m^2).")
+      end
+
+      # EUI
+      source_units = 'GJ/m^2'
+      target_units = 'kBtu/ft^2'
+      if energy_plus_area > 0.0 # don't calculate EUI if building doesn't have any area
+        # todo -  netSiteEnergy deducts for renewable. May want to update this to show gross consumption vs. net consumption
+        eui = @sql.netSiteEnergy.get / energy_plus_area
+      else
+        check_elems << OpenStudio::Attribute.new('flag', "Can't calculate model EUI, building doesn't have any floor area.")
+        return OpenStudio::Attribute.new('check', check_elems)
+      end
+
+      # test using new method
+      if use_old_gem_code
+        target_eui = @model.find_target_eui(target_standard)
+      else
+        std = Standard.build(target_standard)
+        target_eui = std.model_find_target_eui(@model)
+      end
+
+      # check model vs. target for user specified tolerance.
+      if !target_eui.nil?
+        eui_ip_neat = OpenStudio.toNeatString(OpenStudio.convert(eui, source_units, target_units).get, 1, true)
+        target_eui_ip_neat = OpenStudio.toNeatString(OpenStudio.convert(target_eui, source_units, target_units).get, 1, true)
+        if eui < target_eui * (1.0 - min_pass)
+          check_elems << OpenStudio::Attribute.new('flag', "Model EUI of #{eui_ip_neat} (#{target_units}) is less than #{min_pass * 100} % below the expected EUI of #{target_eui_ip_neat} (#{target_units}) for #{target_standard}.")
+        elsif eui > target_eui * (1.0 + max_pass)
+          check_elems << OpenStudio::Attribute.new('flag', "Model EUI of #{eui_ip_neat} (#{target_units}) is more than #{max_pass * 100} % above the expected EUI of #{target_eui_ip_neat} (#{target_units}) for #{target_standard}.")
+        end
+      else
+        check_elems << OpenStudio::Attribute.new('flag', "Can't calculate target EUI. Make sure model has expected climate zone and building type.")
+      end
+    rescue StandardError => e
+      # brief description of ruby error
+      check_elems << OpenStudio::Attribute.new('flag', "Error prevented QAQC check from running (#{e}).")
+
+      # backtrace of ruby error for diagnostic use
+      if @error_backtrace then check_elems << OpenStudio::Attribute.new('flag', e.backtrace.join("\n").to_s) end
+    end
+
+    # add check_elms to new attribute
+    check_elem = OpenStudio::Attribute.new('check', check_elems)
+
+    return check_elem
+    # note: registerWarning and registerValue will be added for checks downstream using os_lib_reporting_qaqc.rb
+  end
+end

data/lib/openstudio/extension/core/check_fan_pwr.rb

@@ -0,0 +1,98 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2019, 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:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+module OsLib_QAQC
+  # Check the fan power (W/cfm) for each air loop fan in the model to identify
+  # unrealistically sized fans.
+  def check_fan_pwr(category, target_standard, max_pwr_delta = 0.1, name_only = false)
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'Fan Power')
+    check_elems << OpenStudio::Attribute.new('category', category)
+    check_elems << OpenStudio::Attribute.new('description', 'Check that fan power vs flow makes sense.')
+
+    # stop here if only name is requested this is used to populate display name for arguments
+    if name_only == true
+      results = []
+      check_elems.each do |elem|
+        results << elem.valueAsString
+      end
+      return results
+    end
+
+    std = Standard.build(target_standard)
+
+    begin
+      # Check each air loop
+      @model.getAirLoopHVACs.each do |plant_loop|
+        # Set the expected W/cfm
+        expected_w_per_cfm = 1.1
+
+        # Check the W/cfm for each fan on each air loop
+        plant_loop.supplyComponents.each do |sc|
+          # Get the W/cfm for the fan
+          obj_type = sc.iddObjectType.valueName.to_s
+          case obj_type
+          when 'OS_Fan_ConstantVolume'
+            actual_w_per_cfm = std.fan_rated_w_per_cfm(sc.to_FanConstantVolume.get)
+          when 'OS_Fan_OnOff'
+            actual_w_per_cfm = std.fan_rated_w_per_cfm(sc.to_FanOnOff.get)
+          when 'OS_Fan_VariableVolume'
+            actual_w_per_cfm = std.fan_rated_w_per_cfm(sc.to_FanVariableVolume.get)
+          else
+            next # Skip non-fan objects
+          end
+
+          # Compare W/cfm to expected/typical values
+          if ((expected_w_per_cfm - actual_w_per_cfm) / actual_w_per_cfm).abs > max_pwr_delta
+            check_elems << OpenStudio::Attribute.new('flag', "For #{sc.name} on #{plant_loop.name}, the actual fan power of #{actual_w_per_cfm.round(1)} W/cfm is more than #{(max_pwr_delta * 100.0).round(2)}% different from the expected #{expected_w_per_cfm} W/cfm.")
+          end
+        end
+      end
+    rescue StandardError => e
+      # brief description of ruby error
+      check_elems << OpenStudio::Attribute.new('flag', "Error prevented QAQC check from running (#{e}).")
+
+      # backtrace of ruby error for diagnostic use
+      if @error_backtrace then check_elems << OpenStudio::Attribute.new('flag', e.backtrace.join("\n").to_s) end
+    end
+
+    # add check_elms to new attribute
+    check_elem = OpenStudio::Attribute.new('check', check_elems)
+
+    return check_elem
+    # note: registerWarning and registerValue will be added for checks downstream using os_lib_reporting_qaqc.rb
+  end
+end

data/lib/openstudio/extension/core/check_internal_loads.rb

@@ -0,0 +1,393 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2019, 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:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+module OsLib_QAQC
+  # include any general notes about QAQC method here
+
+  # checks the number of unmet hours in the model
+  def check_internal_loads(category, target_standard, min_pass, max_pass, name_only = false)
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'Internal Loads')
+    check_elems << OpenStudio::Attribute.new('category', category)
+    if target_standard == 'ICC IECC 2015'
+      check_elems << OpenStudio::Attribute.new('description', 'Check internal loads against Table R405.5.2(1) in ICC IECC 2015 Residential Provisions.')
+    else
+      if target_standard.include?('90.1')
+        display_standard = "ASHRAE #{target_standard}"
+      else
+        display_standard = target_standard
+      end
+      check_elems << OpenStudio::Attribute.new('description', "Check LPD, ventilation rates, occupant density, plug loads, and equipment loads against #{display_standard} and DOE Prototype buildings.")
+    end
+
+    # stop here if only name is requested this is used to populate display name for arguments
+    if name_only == true
+      results = []
+      check_elems.each do |elem|
+        results << elem.valueAsString
+      end
+      return results
+    end
+
+    # Versions of OpenStudio greater than 2.4.0 use a modified version of
+    # openstudio-standards with different method calls.  These methods
+    # require a "Standard" object instead of the standard being passed into method calls.
+    # This Standard object is used throughout the QAQC check.
+    if OpenStudio::VersionString.new(OpenStudio.openStudioVersion) < OpenStudio::VersionString.new('2.4.3')
+      use_old_gem_code = true
+    else
+      use_old_gem_code = false
+      std = Standard.build(target_standard)
+    end
+
+    begin
+      if target_standard == 'ICC IECC 2015'
+
+        num_people = 0.0
+        @model.getSpaceTypes.each do |space_type|
+          next if !space_type.standardsSpaceType.is_initialized
+          next if space_type.standardsSpaceType.get != 'Apartment' # currently only supports midrise apt space type
+          space_type_floor_area = space_type.floorArea
+          space_type_num_people = space_type.getNumberOfPeople(space_type_floor_area)
+          num_people += space_type_num_people
+        end
+
+        # lookup iecc internal loads for the building
+        bedrooms_per_unit = 2.0 # assumption
+        num_units = num_people / 2.5 # Avg 2.5 units per person.
+        if use_old_gem_code
+          target_loads_hash = @model.find_icc_iecc_2015_internal_loads(num_units, bedrooms_per_unit)
+        else
+          target_loads_hash = std.model_find_icc_iecc_2015_internal_loads(@model, num_units, bedrooms_per_unit)
+        end
+
+        # get model internal gains for lights, elec equipment, and gas equipment
+        model_internal_gains_si = 0.0
+        query_eleint_lights = "SELECT Value FROM tabulardatawithstrings WHERE ReportName='AnnualBuildingUtilityPerformanceSummary' and TableName='End Uses' and RowName= 'Interior Lighting' and ColumnName= 'Electricity'"
+        query_elec_equip = "SELECT Value FROM tabulardatawithstrings WHERE ReportName='AnnualBuildingUtilityPerformanceSummary' and TableName='End Uses' and RowName= 'Interior Equipment' and ColumnName= 'Electricity'"
+        query_gas_equip = "SELECT Value FROM tabulardatawithstrings WHERE ReportName='AnnualBuildingUtilityPerformanceSummary' and TableName='End Uses' and RowName= 'Interior Equipment' and ColumnName= 'Natural Gas'"
+        model_internal_gains_si += results_elec = @sql.execAndReturnFirstDouble(query_eleint_lights).get
+        model_internal_gains_si += results_elec = @sql.execAndReturnFirstDouble(query_elec_equip).get
+        model_internal_gains_si += results_elec = @sql.execAndReturnFirstDouble(query_gas_equip).get
+        model_internal_gains_si_kbtu_per_day = OpenStudio.convert(model_internal_gains_si, 'GJ', 'kBtu').get / 365.0 # assumes annual run
+
+        # get target internal loads
+        target_igain_btu_per_day = target_loads_hash['igain_btu_per_day']
+        target_igain_kbtu_per_day = OpenStudio.convert(target_igain_btu_per_day, 'Btu', 'kBtu').get
+
+        # check internal loads
+        if model_internal_gains_si_kbtu_per_day < target_igain_kbtu_per_day * (1.0 - min_pass)
+          check_elems << OpenStudio::Attribute.new('flag', "The model average of #{OpenStudio.toNeatString(model_internal_gains_si_kbtu_per_day, 2, true)} (kBtu/day) is more than #{min_pass * 100} % below the expected value of #{OpenStudio.toNeatString(target_igain_kbtu_per_day, 2, true)} (kBtu/day) for #{target_standard}.")
+        elsif model_internal_gains_si_kbtu_per_day > target_igain_kbtu_per_day * (1.0 + max_pass)
+          check_elems << OpenStudio::Attribute.new('flag', "The model average of #{OpenStudio.toNeatString(model_internal_gains_si_kbtu_per_day, 2, true)} (kBtu/day) is more than #{max_pass * 100} % above the expected value of #{OpenStudio.toNeatString(target_igain_kbtu_per_day, 2, true)} k(Btu/day) for #{target_standard}.")
+        end
+
+        # get target mech vent
+        target_mech_vent_cfm = target_loads_hash['mech_vent_cfm']
+
+        # get model mech vent
+        model_mech_vent_si = 0
+        @model.getSpaceTypes.each do |space_type|
+          next if space_type.floorArea <= 0
+
+          # get necessary space type information
+          floor_area = space_type.floorArea
+          num_people = space_type.getNumberOfPeople(floor_area)
+
+          # get volume for space type for use with ventilation and infiltration
+          space_type_volume = 0.0
+          space_type_exterior_area = 0.0
+          space_type_exterior_wall_area = 0.0
+          space_type.spaces.each do |space|
+            space_type_volume += space.volume * space.multiplier
+            space_type_exterior_area = space.exteriorArea * space.multiplier
+            space_type_exterior_wall_area = space.exteriorWallArea * space.multiplier
+          end
+
+          # get design spec OA object
+          if space_type.designSpecificationOutdoorAir.is_initialized
+            oa = space_type.designSpecificationOutdoorAir.get
+            oa_method = oa.outdoorAirMethod
+            oa_per_person = oa.outdoorAirFlowperPerson * num_people
+            oa_ach = oa.outdoorAirFlowAirChangesperHour * space_type_volume
+            oa_per_area = oa.outdoorAirFlowperFloorArea * floor_area
+            oa_flow_rate = oa.outdoorAirFlowRate
+            oa_space_type_total = oa_per_person + oa_ach + oa_per_area + oa_flow_rate
+
+            value_count = 0
+            if oa_per_person > 0 then value_count += 1 end
+            if oa_ach > 0 then value_count += 1 end
+            if oa_per_area > 0 then value_count += 1 end
+            if oa_flow_rate > 0 then value_count += 1 end
+            if (oa_method != 'Sum') && (value_count > 1)
+              check_elems << OpenStudio::Attribute.new('flag', "Outdoor Air Method for #{space_type.name} was #{oa_method}. Expected value was Sum.")
+            end
+          else
+            oa_space_type_total = 0.0
+          end
+          # add to building total oa
+          model_mech_vent_si += oa_space_type_total
+        end
+
+        # check oa
+        model_mech_vent_cfm = OpenStudio.convert(model_mech_vent_si, 'm^3/s', 'cfm').get
+        if model_mech_vent_cfm < target_mech_vent_cfm * (1.0 - min_pass)
+          check_elems << OpenStudio::Attribute.new('flag', "The model mechanical ventilation of  #{OpenStudio.toNeatString(model_mech_vent_cfm, 2, true)} cfm is more than #{min_pass * 100} % below the expected value of #{OpenStudio.toNeatString(target_mech_vent_cfm, 2, true)} cfm for #{target_standard}.")
+        elsif model_mech_vent_cfm > target_mech_vent_cfm * (1.0 + max_pass)
+          check_elems << OpenStudio::Attribute.new('flag', "The model mechanical ventilation of #{OpenStudio.toNeatString(model_mech_vent_cfm, 2, true)} cfm is more than #{max_pass * 100} % above the expected value of #{OpenStudio.toNeatString(target_mech_vent_cfm, 2, true)} cfm for #{target_standard}.")
+        end
+
+      else
+
+        # loop through all space types used in the model
+        @model.getSpaceTypes.each do |space_type|
+          next if space_type.floorArea <= 0
+
+          # get necessary space type information
+          floor_area = space_type.floorArea
+          num_people = space_type.getNumberOfPeople(floor_area)
+
+          # load in standard info for this space type
+          if use_old_gem_code
+            data = space_type.get_standards_data(target_standard)
+          else
+            data = std.space_type_get_standards_data(space_type)
+          end
+
+          if data.nil? || data.empty?
+
+            # skip if all spaces using this space type are plenums
+            all_spaces_plenums = true
+            space_type.spaces.each do |space|
+              if use_old_gem_code
+                if !space.plenum?
+                  all_spaces_plenums = false
+                  next
+                end
+              else
+                if !std.space_plenum?(space)
+                  all_spaces_plenums = false
+                  next
+                end
+              end
+            end
+
+            if !all_spaces_plenums
+              check_elems << OpenStudio::Attribute.new('flag', "Unexpected standards type for #{space_type.name}, can't validate internal loads.")
+            end
+
+            next
+          end
+
+          # check lpd for space type
+          model_lights_si = space_type.getLightingPowerPerFloorArea(floor_area, num_people)
+          data['lighting_per_area'].nil? ? (target_lights_ip = 0.0) : (target_lights_ip = data['lighting_per_area'])
+          source_units = 'W/m^2'
+          target_units = 'W/ft^2'
+          load_type = 'Lighting Power Density'
+          model_ip = OpenStudio.convert(model_lights_si, source_units, target_units).get
+          target_ip = target_lights_ip.to_f
+          model_ip_neat = OpenStudio.toNeatString(model_ip, 2, true)
+          target_ip_neat = OpenStudio.toNeatString(target_ip, 2, true)
+          if model_ip < target_ip * (1.0 - min_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{min_pass * 100} % below the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          elsif model_ip > target_ip * (1.0 + max_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{max_pass * 100} % above the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          end
+
+          # check electric equipment
+          model_elec_si = space_type.getElectricEquipmentPowerPerFloorArea(floor_area, num_people)
+          data['electric_equipment_per_area'].nil? ? (target_elec_ip = 0.0) : (target_elec_ip = data['electric_equipment_per_area'])
+          source_units = 'W/m^2'
+          target_units = 'W/ft^2'
+          load_type = 'Electric Power Density'
+          model_ip = OpenStudio.convert(model_elec_si, source_units, target_units).get
+          target_ip = target_elec_ip.to_f
+          model_ip_neat = OpenStudio.toNeatString(model_ip, 2, true)
+          target_ip_neat = OpenStudio.toNeatString(target_ip, 2, true)
+          if model_ip < target_ip * (1.0 - min_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{min_pass * 100} % below the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          elsif model_ip > target_ip * (1.0 + max_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{max_pass * 100} % above the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          end
+
+          # check gas equipment
+          model_gas_si = space_type.getGasEquipmentPowerPerFloorArea(floor_area, num_people)
+          data['gas_equipment_per_area'].nil? ? (target_gas_ip = 0.0) : (target_gas_ip = data['gas_equipment_per_area'])
+          source_units = 'W/m^2'
+          target_units = 'Btu/hr*ft^2'
+          load_type = 'Gas Power Density'
+          model_ip = OpenStudio.convert(model_gas_si, source_units, target_units).get
+          target_ip = target_gas_ip.to_f
+          model_ip_neat = OpenStudio.toNeatString(model_ip, 2, true)
+          target_ip_neat = OpenStudio.toNeatString(target_ip, 2, true)
+          if model_ip < target_ip * (1.0 - min_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{min_pass * 100} % below the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          elsif model_ip > target_ip * (1.0 + max_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{max_pass * 100} % above the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          end
+
+          # check people
+          model_occ_si = space_type.getPeoplePerFloorArea(floor_area)
+          data['occupancy_per_area'].nil? ? (target_occ_ip = 0.0) : (target_occ_ip = data['occupancy_per_area'])
+          source_units = '1/m^2' # people/m^2
+          target_units = '1/ft^2' # people per ft^2 (can't add *1000) to the bottom, need to do later
+          load_type = 'Occupancy per Area'
+          model_ip = OpenStudio.convert(model_occ_si, source_units, target_units).get * 1000.0
+          target_ip = target_occ_ip.to_f
+          model_ip_neat = OpenStudio.toNeatString(model_ip, 2, true)
+          target_ip_neat = OpenStudio.toNeatString(target_ip, 2, true)
+          # for people need to update target units just for display. Can't be used for converstion.
+          target_units = 'People/1000 ft^2'
+          if model_ip < target_ip * (1.0 - min_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{min_pass * 100} % below the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          elsif model_ip > target_ip * (1.0 + max_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{max_pass * 100} % above the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          end
+
+          # get volume for space type for use with ventilation and infiltration
+          space_type_volume = 0.0
+          space_type_exterior_area = 0.0
+          space_type_exterior_wall_area = 0.0
+          space_type.spaces.each do |space|
+            space_type_volume += space.volume * space.multiplier
+            space_type_exterior_area = space.exteriorArea * space.multiplier
+            space_type_exterior_wall_area = space.exteriorWallArea * space.multiplier
+          end
+
+          # get design spec OA object
+          if space_type.designSpecificationOutdoorAir.is_initialized
+            oa = space_type.designSpecificationOutdoorAir.get
+            oa_method = oa.outdoorAirMethod
+            oa_per_person = oa.outdoorAirFlowperPerson
+            oa_other = 0.0
+            oa_ach = oa.outdoorAirFlowAirChangesperHour * space_type_volume
+            oa_per_area = oa.outdoorAirFlowperFloorArea * floor_area
+            oa_flow_rate = oa.outdoorAirFlowRate
+            oa_total = oa_ach + oa_per_area + oa_flow_rate
+
+            value_count = 0
+            if oa_per_person > 0 then value_count += 1 end
+            if oa_ach > 0 then value_count += 1 end
+            if oa_per_area > 0 then value_count += 1 end
+            if oa_flow_rate > 0 then value_count += 1 end
+            if (oa_method != 'Sum') && (value_count > 1)
+              check_elems << OpenStudio::Attribute.new('flag', "Outdoor Air Method for #{space_type.name} was #{oa_method}. Expected value was Sum.")
+            end
+          else
+            oa_per_person = 0.0
+            oa_other_total = 0.0
+          end
+
+          # get target values for OA
+          target_oa_per_person_ip = data['ventilation_per_person'].to_f # ft^3/min*person
+          target_oa_ach_ip = data['ventilation_air_changes'].to_f # ach
+          target_oa_per_area_ip = data['ventilation_per_area'].to_f # ft^3/min*ft^2
+          if target_oa_per_person_ip.nil?
+            target_oa_per_person_si = 0.0
+          else
+            target_oa_per_person_si = OpenStudio.convert(target_oa_per_person_ip, 'cfm', 'm^3/s').get
+          end
+          if target_oa_ach_ip.nil?
+            target_oa_ach_si = 0.0
+          else
+            target_oa_ach_si = target_oa_ach_ip * space_type_volume
+          end
+          if target_oa_per_area_ip.nil?
+            target_oa_per_area_si = 0.0
+          else
+            target_oa_per_area_si = OpenStudio.convert(target_oa_per_area_ip, 'cfm/ft^2', 'm^3/s*m^2').get * floor_area
+          end
+          target_oa_total = target_oa_ach_si + target_oa_per_area_si
+
+          # check oa per person
+          source_units = 'm^3/s'
+          target_units = 'cfm'
+          load_type = 'Outdoor Air Per Person'
+          model_ip_neat = OpenStudio.toNeatString(OpenStudio.convert(oa_per_person, source_units, target_units).get, 2, true)
+          target_ip_neat = OpenStudio.toNeatString(target_oa_per_person_ip, 2, true)
+          if oa_per_person < target_oa_per_person_si * (1.0 - min_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{min_pass * 100} % below the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          elsif oa_per_person > target_oa_per_person_si * (1.0 + max_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{max_pass * 100} % above the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          end
+
+          # check other oa
+          source_units = 'm^3/s'
+          target_units = 'cfm'
+          load_type = 'Outdoor Air (Excluding per Person Value)'
+          model_ip_neat = OpenStudio.toNeatString(OpenStudio.convert(oa_total, source_units, target_units).get, 2, true)
+          target_ip_neat = OpenStudio.toNeatString(OpenStudio.convert(target_oa_total, source_units, target_units).get, 2, true)
+          if oa_total < target_oa_total * (1.0 - min_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{min_pass * 100} % below the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          elsif oa_total > target_oa_total * (1.0 + max_pass)
+            check_elems << OpenStudio::Attribute.new('flag', "#{load_type} of #{model_ip_neat} (#{target_units}) for #{space_type.name} is more than #{max_pass * 100} % above the expected value of #{target_ip_neat} (#{target_units}) for #{display_standard}.")
+          end
+        end
+
+        # warn if there are spaces in model that don't use space type unless they appear to be plenums
+        @model.getSpaces.each do |space|
+          if use_old_gem_code
+            next if space.plenum?
+          else
+            next if std.space_plenum?(space)
+          end
+
+          if !space.spaceType.is_initialized
+            check_elems << OpenStudio::Attribute.new('flag', "#{space.name} doesn't have a space type assigned, can't validate internal loads.")
+          end
+        end
+
+        # TODO: - need to address internal loads where fuel is variable like cooking and laundry
+        # todo - For now we are not going to loop through spaces looking for loads beyond what comes from space type
+        # todo - space infiltration
+
+      end
+    rescue StandardError => e
+      # brief description of ruby error
+      check_elems << OpenStudio::Attribute.new('flag', "Error prevented QAQC check from running (#{e}).")
+
+      # backtrace of ruby error for diagnostic use
+      if @error_backtrace then check_elems << OpenStudio::Attribute.new('flag', e.backtrace.join("\n").to_s) end
+    end
+
+    # add check_elms to new attribute
+    check_elem = OpenStudio::Attribute.new('check', check_elems)
+
+    return check_elem
+    # note: registerWarning and registerValue will be added for checks downstream using os_lib_reporting_qaqc.rb
+  end
+end