openstudio-common-measures 0.7.0 → 0.9.0

data/lib/measures/XcelEDAReportingandQAQC/resources/FuelSwap.rb

@@ -0,0 +1,275 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+# what does xcel want to call water-to-water heat pump - Drew -> electric
+# don't forget absorbtion powered chillers eventually
+# what about service water heating? you can have non-connected boilers -> try to pick up changes in boilers
+# preheat and precool coils on OA system
+# not considered fuel switching if going from no fuel -> some fuel
+
+# heating & cooling primary fuel swap
+def heat_cool_fuel_swap_check(base_model, base_sql, prop_model, prop_sql)
+  heat_cool_fuel_swap_check = Check.new
+  heat_cool_fuel_swap_check.name = 'Fuel Swap Check'
+  heat_cool_fuel_swap_check.category = 'Xcel EDA'
+  heat_cool_fuel_swap_check.description = 'Check that the baseline and the design alternative use the same fuels.'
+  # make a hash to hold the results
+  zone_fuels = Hash.new { |h, k| h[k] = {} }
+  # get the zones from both models
+  baseline_zones = base_model.getThermalZones
+  proposed_zones = prop_model.getThermalZones
+  # get zone names from both models.  will be used as basis of fuel comparison
+  baseline_zone_names = []
+  proposed_zone_names = []
+  # make arrays of the zone names from each model
+  baseline_zones.each do |baseline_zone|
+    baseline_zone_names << baseline_zone.name.get
+  end
+  proposed_zones.each do |proposed_zone|
+    proposed_zone_names << proposed_zone.name.get
+  end
+  # output the sorted zone name lists
+  debug_puts('**baseline**')
+  debug_puts(baseline_zone_names.sort)
+  debug_puts('**proposed**')
+  debug_puts(proposed_zone_names.sort)
+
+  # check the heating fuel type of a plant loop
+  def plant_loop_heating_fuel(plant_loop)
+    debug_puts("  looking for plant loop heating fuel for #{plant_loop.name}")
+    # create an array to hold all the heating fuels on the plant loop
+    plant_loop_heating_fuels = []
+    # loop throug all the supply components and check heating fuel for each one
+    plant_loop.supplyComponents.each do |supply_component|
+      if supply_component.to_DistrictHeating.empty? == false
+        plant_loop_heating_fuels << 'District Heating'
+      elsif supply_component.to_BoilerHotWater.empty? == false
+        boiler_hot_water = supply_component.to_BoilerHotWater.get
+        plant_loop_heating_fuels << boiler_hot_water.fuelType
+      end
+    end
+    return plant_loop_heating_fuels.uniq
+  end
+
+  # check the cooling fuel type of a plant loop
+  def plant_loop_cooling_fuel(plant_loop)
+    debug_puts("  looking for plant loop heating fuel for #{plant_loop.name}")
+    # create an array to hold all the heating fuels on the plant loop
+    plant_loop_cooling_fuels = []
+    # loop throug all the supply components and check heating fuel for each one
+    plant_loop.supplyComponents.each do |supply_component|
+      if supply_component.to_DistrictCooling.empty? == false
+        plant_loop_cooling_fuels << 'District Cooling'
+      elsif supply_component.to_ChillerElectricEIR.empty? == false
+        plant_loop_cooling_fuels << 'Electricity'
+      end
+    end
+    return plant_loop_cooling_fuels.uniq
+  end
+
+  # check the heating fuel type of a reheat terminal
+  def reheat_terminal_heating_fuel(reheat_terminal)
+    debug_puts("  looking for reheat terminal heating fuel for #{reheat_terminal.name}")
+    # create an array to hold all the heating fuels in the terminal
+    reheat_terminal_heating_fuels = []
+    # get the reheat coil
+    heating_coil = reheat_terminal.reheatCoil
+    if heating_coil.to_CoilHeatingDXSingleSpeed.empty? == false
+      reheat_terminal_heating_fuels += get_heating_coil_heating_fuel(heating_coil)
+    elsif heating_coil.to_CoilHeatingElectric.empty? == false
+      reheat_terminal_heating_fuels += get_heating_coil_heating_fuel(heating_coil)
+    elsif heating_coil.to_CoilHeatingGas.empty? == false
+      reheat_terminal_heating_fuels += get_heating_coil_heating_fuel(heating_coil)
+    elsif heating_coil.to_CoilHeatingWater.empty? == false
+      reheat_terminal_heating_fuels += get_heating_coil_heating_fuel(heating_coil)
+    end
+    return reheat_terminal_heating_fuels.uniq
+  end
+
+  # check the heating fuel type of a heating coil
+  def get_heating_coil_heating_fuel(heating_coil)
+    debug_puts("  looking for heating coil heating fuel for #{heating_coil.name}")
+    # create an array to hold all the heating fuels in the terminal
+    heating_coil_heating_fuels = []
+    # get the reheat coil
+    if heating_coil.to_CoilHeatingDXSingleSpeed.empty? == false
+      heating_coil_heating_fuels << 'Electricity'
+    elsif heating_coil.to_CoilHeatingElectric.empty? == false
+      heating_coil_heating_fuels << 'Electricity'
+    elsif heating_coil.to_CoilHeatingGas.empty? == false
+      heating_coil_heating_fuels << 'Natural Gas'
+    elsif heating_coil.to_CoilHeatingWater.empty? == false
+      # need to check what the heating fuel for the plant loop is
+      heating_coil = heating_coil.to_CoilHeatingWater.get
+      plant_loop = heating_coil.plantLoop.get
+      reheat_coil_fuels = plant_loop_heating_fuel(plant_loop)
+      heating_coil_heating_fuels += reheat_coil_fuels
+    end
+    return heating_coil_heating_fuels
+  end
+
+  # check the cooling fuel type of a cooling coil
+  def get_cooling_coil_cooling_fuel(cooling_coil)
+    debug_puts("  looking for cooling coil cooling fuel for #{cooling_coil.name}")
+    # create an array to hold all the heating fuels in the terminal
+    cooling_coil_cooling_fuels = []
+    if cooling_coil.to_CoilCoolingDXSingleSpeed.empty? == false
+      cooling_coil_cooling_fuels << 'Electricity'
+    elsif cooling_coil.to_CoilCoolingDXTwoSpeed.empty? == false
+      cooling_coil_cooling_fuels << 'Electricity'
+    elsif cooling_coil.to_EvaporativeCoolerDirectResearchSpecial.empty? == false
+      cooling_coil_cooling_fuels << 'Electricity'
+    elsif cooling_coil.to_CoilCoolingWater.empty? == false
+      # need to check what the cooling fuel for the plant loop is
+      cooling_coil = cooling_coil.to_CoilCoolingWater.get
+      plant_loop = cooling_coil.plantLoop.get
+      cooling_coil_cooling_fuels += plant_loop_cooling_fuel(plant_loop)
+    end
+    return cooling_coil_cooling_fuels
+  end
+
+  # check the heating fuels for a zone
+  def get_zone_heating_fuels(zone)
+    # create an array to hold the results
+    equipment_heating_fuels = []
+    zone.equipment.each do |equipment|
+      # TODO: Enumerable and code blocks and collect or select methods
+      debug_puts("  #{equipment.name}")
+      if equipment.to_AirTerminalSingleDuctParallelPIUReheat.empty? == false
+        terminal = equipment.to_AirTerminalSingleDuctParallelPIUReheat.get
+        equipment_heating_fuels += reheat_terminal_heating_fuel(terminal)
+      elsif equipment.to_AirTerminalSingleDuctVAVReheat.empty? == false
+        terminal = equipment.to_AirTerminalSingleDuctVAVReheat.get
+        equipment_heating_fuels += reheat_terminal_heating_fuel(terminal)
+      elsif equipment.to_ZoneHVACPackagedTerminalHeatPump.empty? == false
+        equipment_heating_fuels << 'Electricity'
+      end
+    end
+    return equipment_heating_fuels.uniq.sort
+  end
+
+  # check the cooling fuels for a zone
+  def get_zone_cooling_fuels(zone)
+    # create an array to hold the results
+    equipment_cooling_fuels = []
+    zone.equipment.each do |equipment|
+      # TODO: Enumerable and code blocks and collect or select methods
+      debug_puts("  #{equipment.name}")
+      if equipment.to_ZoneHVACPackagedTerminalAirConditioner.empty? == false
+        equipment_cooling_fuels << 'Electricity'
+      end
+    end
+    return equipment_cooling_fuels.uniq.sort
+  end
+
+  # check the heating fuels for a zones airloop
+  def get_zone_airloop_heating_fuels(zone)
+    # create an array to hold the results
+    airloop_heating_fuels = []
+    if zone.airLoopHVAC.empty? #== false
+      debug_puts('  This zone is not connected to an airloop.')
+      return airloop_heating_fuels
+    else
+      zone.airLoopHVAC.get.supplyComponents.each do |supply_component|
+        if supply_component.to_CoilHeatingDXSingleSpeed.empty? == false
+          airloop_heating_fuels += get_heating_coil_heating_fuel(supply_component)
+        elsif supply_component.to_CoilHeatingElectric.empty? == false
+          airloop_heating_fuels += get_heating_coil_heating_fuel(supply_component)
+        elsif supply_component.to_CoilHeatingGas.empty? == false
+          airloop_heating_fuels += get_heating_coil_heating_fuel(supply_component)
+        elsif supply_component.to_CoilHeatingWater.empty? == false
+          airloop_heating_fuels += get_heating_coil_heating_fuel(supply_component)
+        end
+      end
+    end
+    return airloop_heating_fuels.uniq.sort
+  end
+
+  # check the cooling fuels for a zones airloop
+  def get_zone_airloop_cooling_fuels(zone)
+    # create an array to hold the results
+    airloop_cooling_fuels = []
+    if zone.airLoopHVAC.empty? #== false
+      debug_puts('  This zone is not connected to an airloop.')
+      return airloop_cooling_fuels
+    else
+      zone.airLoopHVAC.get.supplyComponents.each do |supply_component|
+        if supply_component.to_CoilCoolingDXSingleSpeed.empty? == false
+          airloop_cooling_fuels += get_cooling_coil_cooling_fuel(supply_component)
+        elsif supply_component.to_CoilCoolingDXTwoSpeed.empty? == false
+          airloop_cooling_fuels += get_cooling_coil_cooling_fuel(supply_component)
+        elsif supply_component.to_EvaporativeCoolerDirectResearchSpecial.empty? == false
+          airloop_cooling_fuels += get_cooling_coil_cooling_fuel(supply_component)
+        elsif supply_component.to_CoilCoolingWater.empty? == false
+          airloop_cooling_fuels += get_cooling_coil_cooling_fuel(supply_component)
+        end
+      end
+    end
+    return airloop_cooling_fuels.uniq.sort
+  end
+
+  # loop through all thermal zones, comparing fuels for heating and cooling
+  baseline_zone_names.sort.each do |baseline_zone_name|
+    # first, make sure the zone exists in both models.  use names to compare.
+    if !proposed_zone_names.include?(baseline_zone_name)
+      heat_cool_fuel_swap_check.add_flag(Flag.new($eda, "The zone called #{baseline_zone_name} exists in the baseline model, but not the proposed model, therfore the check for switching of primary heating and cooling fuels could not be run for this zone"))
+      debug_puts "The zone called #{baseline_zone_name} exists in the baseline model, but not the proposed model, therfore the check for switching of primary heating and cooling fuels could not be run for this zone"
+      next
+    end
+    debug_puts('****')
+    debug_puts("Zone name = #{baseline_zone_name}")
+    # default heating and cooling sources to "Unknown" for all zones
+    baseline_zone_hvac_heating = 'Unknown'
+    baseline_zone_hvac_cooling = 'Unknown'
+    baseline_airloop_heating = 'Unknown'
+    baseline_airloop_cooling = 'Unknown'
+    proposed_zone_hvac_heating = 'Unknown'
+    proposed_zone_hvac_cooling = 'Unknown'
+    proposed_airloop_heating = 'Unknown'
+    proposed_airloop_cooling = 'Unknown'
+    # since zone exists in both models, get each zone by name
+    baseline_zone = base_model.getObjectsByName(baseline_zone_name)[0].to_ThermalZone.get
+    proposed_zone = prop_model.getObjectsByName(baseline_zone_name)[0].to_ThermalZone.get
+
+    # check the zone hvac heating fuel(s)
+    debug_puts("checking the zone-level equipment's heating fuel(s)")
+    baseline_zone_hvac_heating = get_zone_heating_fuels(baseline_zone)
+    proposed_zone_hvac_heating = get_zone_heating_fuels(proposed_zone)
+    # throw a flag if different
+    if baseline_zone_hvac_heating != proposed_zone_hvac_heating
+      heat_cool_fuel_swap_check.add_flag(Flag.new($eda, "Zone-level heating fuel switching: zone name = #{baseline_zone_name}; baseline_zone_hvac_heating = #{baseline_zone_hvac_heating}; proposed_zone_hvac_heating = #{proposed_zone_hvac_heating}"))
+    end
+
+    # check the zone hvac cooling fuel(s)
+    debug_puts("checking the zone-level equipment's cooling fuel(s)")
+    baseline_zone_hvac_cooling = get_zone_cooling_fuels(baseline_zone)
+    proposed_zone_hvac_cooling = get_zone_cooling_fuels(proposed_zone)
+    # throw a flag if different
+    if baseline_zone_hvac_cooling != proposed_zone_hvac_cooling
+      heat_cool_fuel_swap_check.add_flag(Flag.new($eda, "Zone-level cooling fuel switching: zone name = #{baseline_zone_name}; baseline_zone_hvac_cooling = #{baseline_zone_hvac_cooling}; proposed_zone_hvac_cooling = #{proposed_zone_hvac_cooling}"))
+    end
+
+    # check the zone airloop heating fuel(s)
+    debug_puts("checking the zone's airloop's heating fuel(s)")
+    baseline_airloop_heating = get_zone_airloop_heating_fuels(baseline_zone)
+    proposed_airloop_heating = get_zone_airloop_heating_fuels(proposed_zone)
+    # throw a flag if different
+    if baseline_airloop_heating != proposed_airloop_heating
+      heat_cool_fuel_swap_check.add_flag(Flag.new($eda, "Airloop heating fuel switching: zone name = #{baseline_zone_name}; baseline_airloop_heating = #{baseline_airloop_heating}; proposed_airloop_heating = #{proposed_airloop_heating}"))
+    end
+
+    # check the zone airloop cooling fuel(s)
+    debug_puts("checking the zone's airloop's cooling fuel(s)")
+    baseline_airloop_cooling = get_zone_airloop_cooling_fuels(baseline_zone)
+    proposed_airloop_cooling = get_zone_airloop_cooling_fuels(proposed_zone)
+    # throw a flag if different
+    if baseline_airloop_cooling != proposed_airloop_cooling
+      heat_cool_fuel_swap_check.add_flag(Flag.new($eda, "Airloop cooling fuel switching: zone name = #{baseline_zone_name}; baseline_airloop_cooling = #{baseline_airloop_cooling}; proposed_airloop_cooling = #{proposed_airloop_cooling}"))
+    end
+  end
+  debug_puts heat_cool_fuel_swap_check.inspect
+
+  return heat_cool_fuel_swap_check
+end

data/lib/measures/XcelEDAReportingandQAQC/resources/PeakHeatCoolMonth.rb

@@ -0,0 +1,191 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+class XcelEDAReportingandQAQC < OpenStudio::Measure::ReportingMeasure
+  # for cooling electricity, include heat rejection electricity
+  # should normalize by # days/month - Drew -> yes
+
+  # peak heating and cooling months
+  def peak_heat_cool_mo_check
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'Peak Heating and Cooling Month Check')
+    check_elems << OpenStudio::Attribute.new('category', 'Xcel EDA')
+    check_elems << OpenStudio::Attribute.new('description', 'Check that the heating and cooling energy peak during the expected time of year')
+
+    # heating
+    heating_electricity_peak_energy = 0
+    heating_gas_peak_energy = 0
+    heating_other_fuel_peak_energy = 0
+    heating_district_cooling_peak_energy = 0
+    heating_district_heating_peak_energy = 0
+    # cooling
+    cooling_electricity_peak_energy = 0
+    cooling_gas_peak_energy = 0
+    cooling_other_fuel_peak_energy = 0
+    cooling_district_cooling_peak_energy = 0
+    cooling_district_heating_peak_energy = 0
+
+    # heating
+    heating_electricity_peak_mo = 'NotAMonth'.to_MonthOfYear
+    heating_gas_peak_mo = 'NotAMonth'.to_MonthOfYear
+    heating_other_fuel_peak_mo = 'NotAMonth'.to_MonthOfYear
+    heating_district_cooling_peak_mo = 'NotAMonth'.to_MonthOfYear
+    heating_district_heating_peak_mo = 'NotAMonth'.to_MonthOfYear
+    # cooling
+    cooling_electricity_peak_mo = 'NotAMonth'.to_MonthOfYear
+    cooling_gas_peak_mo = 'NotAMonth'.to_MonthOfYear
+    cooling_other_fuel_peak_mo = 'NotAMonth'.to_MonthOfYear
+    cooling_district_cooling_peak_mo = 'NotAMonth'.to_MonthOfYear
+    cooling_district_heating_peak_mo = 'NotAMonth'.to_MonthOfYear
+
+    # loop through all of the months, finding the peak month for
+    # heating and cooling for each fuel type
+    (1..12).each do |month|
+      month = OpenStudio::MonthOfYear.new(month)
+      heating = 'Heating'.to_EndUseCategoryType
+      cooling = 'Cooling'.to_EndUseCategoryType
+      electricity = 'Electricity'.to_EndUseFuelType
+      gas = 'Gas'.to_EndUseFuelType
+      other_fuel = 'OtherFuel_1'.to_EndUseFuelType
+      district_cooling = 'DistrictCooling'.to_EndUseFuelType
+      district_heating = 'DistrictHeating'.to_EndUseFuelType
+
+      # heating
+      if @sql.energyConsumptionByMonth(electricity, heating, month).is_initialized
+        if @sql.energyConsumptionByMonth(electricity, heating, month).get > heating_electricity_peak_energy
+          heating_electricity_peak_energy = @sql.energyConsumptionByMonth(electricity, heating, month).get
+          heating_electricity_peak_mo = month
+        end
+      end
+
+      if @sql.energyConsumptionByMonth(gas, heating, month).is_initialized
+        if @sql.energyConsumptionByMonth(gas, heating, month).get > heating_gas_peak_energy
+          heating_gas_peak_energy = @sql.energyConsumptionByMonth(gas, heating, month).get
+          heating_gas_peak_mo = month
+        end
+      end
+
+      if @sql.energyConsumptionByMonth(other_fuel, heating, month).is_initialized
+        if @sql.energyConsumptionByMonth(other_fuel, heating, month).get > heating_other_fuel_peak_energy
+          heating_other_fuel_peak_energy = @sql.energyConsumptionByMonth(other_fuel, heating, month).get
+          heating_other_fuel_peak_mo = month
+        end
+      end
+
+      if @sql.energyConsumptionByMonth(district_cooling, heating, month).is_initialized
+        if @sql.energyConsumptionByMonth(district_cooling, heating, month).get > heating_district_cooling_peak_energy
+          heating_district_cooling_peak_energy = @sql.energyConsumptionByMonth(district_cooling, heating, month).get
+          heating_district_cooling_peak_mo = month
+        end
+      end
+
+      if @sql.energyConsumptionByMonth(district_heating, heating, month).is_initialized
+        if @sql.energyConsumptionByMonth(district_heating, heating, month).get > heating_district_heating_peak_energy
+          heating_district_heating_peak_energy = @sql.energyConsumptionByMonth(district_heating, heating, month).get
+          heating_district_heating_peak_mo = month
+        end
+      end
+
+      # cooling
+      if @sql.energyConsumptionByMonth(electricity, cooling, month).is_initialized
+        if @sql.energyConsumptionByMonth(electricity, cooling, month).get > cooling_electricity_peak_energy
+          cooling_electricity_peak_energy = @sql.energyConsumptionByMonth(electricity, cooling, month).get
+          cooling_electricity_peak_mo = month
+        end
+      end
+
+      if @sql.energyConsumptionByMonth(gas, cooling, month).is_initialized
+        if @sql.energyConsumptionByMonth(gas, cooling, month).get > cooling_gas_peak_energy
+          cooling_gas_peak_energy = @sql.energyConsumptionByMonth(gas, cooling, month).get
+          cooling_gas_peak_mo = month
+        end
+      end
+
+      if @sql.energyConsumptionByMonth(other_fuel, cooling, month).is_initialized
+        if @sql.energyConsumptionByMonth(other_fuel, cooling, month).get > cooling_other_fuel_peak_energy
+          cooling_other_fuel_peak_energy = @sql.energyConsumptionByMonth(other_fuel, cooling, month).get
+          cooling_other_fuel_peak_mo = month
+        end
+      end
+
+      if @sql.energyConsumptionByMonth(district_cooling, cooling, month).is_initialized
+        if @sql.energyConsumptionByMonth(district_cooling, cooling, month).get > cooling_district_cooling_peak_energy
+          cooling_district_cooling_peak_energy = @sql.energyConsumptionByMonth(district_cooling, cooling, month).get
+          cooling_district_cooling_peak_mo = month
+        end
+      end
+
+      if @sql.energyConsumptionByMonth(district_heating, cooling, month).is_initialized
+        if @sql.energyConsumptionByMonth(district_heating, cooling, month).get > cooling_district_heating_peak_energy
+          cooling_district_heating_peak_energy = @sql.energyConsumptionByMonth(district_heating, cooling, month).get
+          cooling_district_heating_peak_mo = month
+        end
+      end
+    end
+
+    # define winter
+    winter = ['Dec', 'Jan', 'Feb', 'Mar', 'NotAMonth']
+
+    # define summer
+    summer = ['Jun', 'Jul', 'Aug', 'NotAMonth']
+
+    # peak heating should occur during winter for all fuel types
+    unless winter.include?(heating_electricity_peak_mo.valueName)
+      check_elems << OpenStudio::Attribute.new('flag', "Peak electricity consumption for heating does not occur in winter as expected; it occurs in #{heating_electricity_peak_mo.valueName}")
+      @runner.registerWarning("Peak electricity consumption for heating does not occur in winter as expected; it occurs in #{heating_electricity_peak_mo.valueName}")
+    end
+
+    unless winter.include?(heating_gas_peak_mo.valueName)
+      check_elems << OpenStudio::Attribute.new('flag', "Peak gas consumption for heating does not occur in winter as expected; it occurs in #{heating_gas_peak_mo.valueName}")
+      @runner.registerWarning("Peak gas consumption for heating does not occur in winter as expected; it occurs in #{heating_gas_peak_mo.valueName}")
+    end
+
+    unless winter.include?(heating_other_fuel_peak_mo.valueName)
+      check_elems << OpenStudio::Attribute.new('flag', "Peak other fuel consumption for heating does not occur in winter as expected; it occurs in #{heating_other_fuel_peak_mo.valueName}")
+      @runner.registerWarning("Peak other fuel consumption for heating does not occur in winter as expected; it occurs in #{heating_other_fuel_peak_mo.valueName}")
+    end
+
+    unless winter.include?(heating_district_cooling_peak_mo.valueName)
+      check_elems << OpenStudio::Attribute.new('flag', "Peak district cooling consumption for heating does not occur in winter as expected; it occurs in #{heating_district_cooling_peak_mo.valueName}")
+      @runner.registerWarning("Peak district cooling consumption for heating does not occur in winter as expected; it occurs in #{heating_district_cooling_peak_mo.valueName}")
+    end
+
+    unless winter.include?(heating_district_heating_peak_mo.valueName)
+      check_elems << OpenStudio::Attribute.new('flag', "Peak district heating consumption for heating does not occur in winter as expected; it occurs in #{heating_district_heating_peak_mo.valueName}")
+      @runner.registerWarning("Peak district heating consumption for heating does not occur in winter as expected; it occurs in #{heating_district_heating_peak_mo.valueName}")
+    end
+
+    # peak cooling should occur during summer for all fuel types
+    unless summer.include?(cooling_electricity_peak_mo.valueName)
+      check_elems << OpenStudio::Attribute.new('flag', "Peak electricity consumption for cooling does not occur in summer as expected; it occurs in #{cooling_electricity_peak_mo.valueName}")
+      @runner.registerWarning("Peak electricity consumption for cooling does not occur in summer as expected; it occurs in #{cooling_electricity_peak_mo.valueName}")
+    end
+
+    unless summer.include?(cooling_gas_peak_mo.valueName)
+      check_elems << OpenStudio::Attribute.new('flag', "Peak gas consumption for cooling does not occur in summer as expected; it occurs in #{cooling_gas_peak_mo.valueName}")
+      @runner.registerWarning("Peak gas consumption for cooling does not occur in summer as expected; it occurs in #{cooling_gas_peak_mo.valueName}")
+    end
+
+    unless summer.include?(cooling_other_fuel_peak_mo.valueName)
+      check_elems << OpenStudio::Attribute.new('flag', "Peak other fuel consumption for cooling does not occur in summer as expected; it occurs in #{cooling_other_fuel_peak_mo.valueName}")
+      @runner.registerWarning("Peak other fuel consumption for cooling does not occur in summer as expected; it occurs in #{cooling_other_fuel_peak_mo.valueName}")
+    end
+
+    unless summer.include?(cooling_district_cooling_peak_mo.valueName)
+      check_elems << OpenStudio::Attribute.new('flag', "Peak district cooling consumption for cooling does not occur in summer as expected; it occurs in #{cooling_district_cooling_peak_mo.valueName}")
+      @runner.registerWarning("Peak district cooling consumption for cooling does not occur in summer as expected; it occurs in #{cooling_district_cooling_peak_mo.valueName}")
+    end
+
+    unless summer.include?(cooling_district_heating_peak_mo.valueName)
+      check_elems << OpenStudio::Attribute.new('flag', "Peak district heating consumption for cooling does not occur in summer as expected; it occurs in #{cooling_district_heating_peak_mo.valueName}")
+      @runner.registerWarning("Peak district heating consumption for cooling does not occur in summer as expected; it occurs in #{cooling_district_heating_peak_mo.valueName}")
+    end
+
+    check_elem = OpenStudio::Attribute.new('check', check_elems)
+
+    return check_elem
+  end
+end

data/lib/measures/XcelEDAReportingandQAQC/resources/UnmetHrs.rb

@@ -0,0 +1,45 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+class XcelEDAReportingandQAQC < OpenStudio::Measure::ReportingMeasure
+  # have the xcel protocol set the reporting tolerance for deltaF (DOE2 has 0.55C tolerance - Brent suggests 0.55C for E+ too)
+  # check the setpoints in the protocol
+  # could we do a custom report to show the thermostat schedules? during occupied and unoccupied times
+
+  # checks the number of unmet hours in the model
+  def unmet_hrs_check
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'Unmet Hours Check')
+    check_elems << OpenStudio::Attribute.new('category', 'General')
+    check_elems << OpenStudio::Attribute.new('description', 'Check that the heating and cooling systems are meeting their setpoints for the entire simulation period')
+
+    # setup the queries
+    heating_setpoint_unmet_query = "SELECT Value FROM TabularDataWithStrings WHERE (ReportName='SystemSummary') AND (ReportForString='Entire Facility') AND (TableName='Time Setpoint Not Met') AND (RowName = 'Facility') AND (ColumnName='During Heating')"
+    cooling_setpoint_unmet_query = "SELECT Value FROM TabularDataWithStrings WHERE (ReportName='SystemSummary') AND (ReportForString='Entire Facility') AND (TableName='Time Setpoint Not Met') AND (RowName = 'Facility') AND (ColumnName='During Cooling')"
+
+    # get the info
+    heating_setpoint_unmet = @sql.execAndReturnFirstDouble(heating_setpoint_unmet_query)
+    cooling_setpoint_unmet = @sql.execAndReturnFirstDouble(cooling_setpoint_unmet_query)
+
+    # make sure all the data are availalbe
+    if heating_setpoint_unmet.empty? || cooling_setpoint_unmet.empty?
+      check_elems << OpenStudio::Attribute.new('flag', 'Hours heating or cooling unmet data unavailable; check not run')
+      @runner.registerWarning('Hours heating or cooling unmet data unavailable; check not run')
+    end
+
+    # aggregate heating and cooling hrs
+    heating_or_cooling_setpoint_unmet = heating_setpoint_unmet.get + cooling_setpoint_unmet.get
+    # flag if heating + cooling unmet hours > 300
+    if heating_or_cooling_setpoint_unmet > 300
+      check_elems << OpenStudio::Attribute.new('flag', "Hours heating or cooling unmet is #{heating_or_cooling_setpoint_unmet}; > the Xcel EDA limit of 300 hrs")
+      @runner.registerWarning("Hours heating or cooling unmet is #{heating_or_cooling_setpoint_unmet}; > the Xcel EDA limit of 300 hrs")
+    end
+
+    check_elem = OpenStudio::Attribute.new('check', check_elems)
+
+    return check_elem
+  end
+end

data/lib/measures/XcelEDATariffSelectionandModelSetup/LICENSE.md

@@ -0,0 +1,13 @@
+OpenStudio(R), Copyright (c) 2008, 2023 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:
+
+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. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “OpenStudio®”. Except to comply with the foregoing, the term “OpenStudio®”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance.
+
+4. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
+
+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.

data/lib/measures/XcelEDATariffSelectionandModelSetup/README.md

@@ -0,0 +1,40 @@
+
+
+###### (Automatically generated documentation)
+
+# XcelEDATariffSelectionandModelSetup
+
+## Description
+
+
+## Modeler Description
+
+
+## Measure Type
+EnergyPlusMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+### Select an Electricity Tariff.
+
+**Name:** elec_tar,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Select a Gas Tariff.
+
+**Name:** gas_tar,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+
+

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

@@ -0,0 +1,42 @@
+<%#= README.md.erb is used to auto-generate README.md. %>
+<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
+###### (Automatically generated documentation)
+
+# <%= name %>
+
+## Description
+<%= description %>
+
+## Modeler Description
+<%= modelerDescription %>
+
+## Measure Type
+<%= measureType %>
+
+## Taxonomy
+<%= taxonomy %>
+
+## Arguments
+
+<% arguments.each do |argument| %>
+### <%= argument[:display_name] %>
+<%= argument[:description] %>
+**Name:** <%= argument[:name] %>,
+**Type:** <%= argument[:type] %>,
+**Units:** <%= argument[:units] %>,
+**Required:** <%= argument[:required] %>,
+**Model Dependent:** <%= argument[:model_dependent] %>
+<% end %>
+
+<% if arguments.size == 0 %>
+<%= "This measure does not have any user arguments" %>
+<% end %>
+
+<% if outputs.size > 0 %>
+## Outputs
+<% output_names = [] %>
+<% outputs.each do |output| %>
+<% output_names << output[:display_name] %>
+<% end %>
+<%= output_names.join(", ") %>
+<% end %>