openstudio-common-measures 0.7.0 → 0.8.0

data/lib/measures/XcelEDAReportingandQAQC/measure.rb

@@ -0,0 +1,201 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+# start the measure
+class XcelEDAReportingandQAQC < OpenStudio::Measure::ReportingMeasure
+
+  # require all .rb files in resources folder
+  Dir[File.dirname(__FILE__) + '/resources/*.rb'].each { |file| require file }
+  # incude module
+  include OsLib_CreateResults
+
+  # define the name that a user will see, this method may be deprecated as
+  # the display name in PAT comes from the name field in measure.xml
+  def name
+    return 'XcelEDAReportingandQAQC'
+  end
+
+  # define the arguments that the user will input
+  def arguments(model = nil)
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    return args
+  end
+
+  # return a vector of IdfObject's to request EnergyPlus objects needed by the run method
+  def energyPlusOutputRequests(runner, user_arguments)
+    super(runner, user_arguments)
+
+    result = OpenStudio::IdfObjectVector.new
+
+    # Request the day type to use in the peak demand window checks.
+    result << OpenStudio::IdfObject.load('Output:Variable,*,Site Day Type Index,timestep;').get
+
+    return result
+  end
+
+  # define what happens when the measure is run
+  def run(runner, user_arguments)
+    super(runner, user_arguments)
+
+    # make the runner a class variable
+    @runner = runner
+
+    # use the built-in error checking
+    if !runner.validateUserArguments(arguments, user_arguments)
+      return false
+    end
+
+    runner.registerInitialCondition('Starting QAQC report generation')
+
+    # get the last model and sql file
+    @model = runner.lastOpenStudioModel
+    if @model.is_initialized
+      @model = @model.get
+    else
+      runner.registerError('Cannot find last model.')
+      return false
+    end
+
+    @sql = runner.lastEnergyPlusSqlFile
+    if @sql.is_initialized
+      @sql = @sql.get
+    else
+      runner.registerError('Cannot find last sql file.')
+      return false
+    end
+
+    # define the time-of-use periods for electricity consumption
+    electricity_consumption_tou_periods = [
+      {
+        'tou_name' => 'system_peak',
+        'tou_id' => 1,
+        'skip_weekends' => true,
+        'skip_holidays' => true,
+        'start_mo' => 'June',
+        'start_day' => 1,
+        'start_hr' => 14,
+        'end_mo' => 'September',
+        'end_day' => 30,
+        'end_hr' => 18
+      },
+      {
+        'tou_name' => 'peak',
+        'tou_id' => 2,
+        'skip_weekends' => true,
+        'skip_holidays' => true,
+        'start_mo' => 'January',
+        'start_day' => 1,
+        'start_hr' => 7,
+        'end_mo' => 'December',
+        'end_day' => 31,
+        'end_hr' => 22
+      },
+      {
+        'tou_name' => 'low_value_spring',
+        'tou_id' => 4,
+        'skip_weekends' => false,
+        'skip_holidays' => false,
+        'start_mo' => 'February',
+        'start_day' => 1,
+        'start_hr' => 0,
+        'end_mo' => 'April',
+        'end_day' => 30,
+        'end_hr' => 6
+      },
+      {
+        'tou_name' => 'low_value_fall',
+        'tou_id' => 4,
+        'skip_weekends' => false,
+        'skip_holidays' => false,
+        'start_mo' => 'November',
+        'start_day' => 1,
+        'start_hr' => 0,
+        'end_mo' => 'November',
+        'end_day' => 30,
+        'end_hr' => 6
+      },
+      {
+        'tou_name' => 'average',
+        'tou_id' => 3,
+        'skip_weekends' => false,
+        'skip_holidays' => false,
+        'start_mo' => 'January',
+        'start_day' => 1,
+        'start_hr' => 0,
+        'end_mo' => 'December',
+        'end_day' => 31,
+        'end_hr' => 24
+      }
+    ]
+
+    # vector to store the results and checks
+    report_elems = OpenStudio::AttributeVector.new
+    report_elems << create_results(skip_weekends = true,
+                                   skip_holidays = true,
+                                   start_mo = 'June',
+                                   start_day = 1,
+                                   start_hr = 14,
+                                   end_mo = 'September',
+                                   end_day = 30,
+                                   end_hr = 18,
+                                   electricity_consumption_tou_periods)
+
+    # create an attribute vector to hold the checks
+    check_elems = OpenStudio::AttributeVector.new
+
+    # unmet hours check
+    check_elems << unmet_hrs_check
+
+    # energy use for cooling and heating as percentage of total energy check
+    check_elems << enduse_pcts_check
+
+    # peak heating and cooling months check
+    check_elems << peak_heat_cool_mo_check
+
+    # EUI check
+    check_elems << eui_check
+
+    # Register Values for all of the checks
+    check_elems.each do |check|
+      check_uid = OpenStudio.removeBraces(OpenStudio.createUUID)
+      # loop through attributes (name,category,description,then optionally one or more flag attributes)
+      check.valueAsAttributeVector.each_with_index do |value, index|
+        if index == 0 # name
+          runner.registerValue("qaqc_name_#{check_uid}", value.valueAsString)
+        elsif index == 1 # category
+          runner.registerValue("qaqc_cat_#{check_uid}", value.valueAsString)
+        elsif index == 2 # description
+          runner.registerValue("qaqc_desc_#{check_uid}", value.valueAsString)
+        else # flag
+          flag_uid = OpenStudio.removeBraces(OpenStudio.createUUID)
+          runner.registerValue("qaqc_flag_#{check_uid}_#{flag_uid}", value.valueAsString)
+        end
+      end
+    end
+
+    # end checks
+    report_elems << OpenStudio::Attribute.new('checks', check_elems)
+
+    # create an extra layer of report.  the first level gets thrown away.
+    top_level_elems = OpenStudio::AttributeVector.new
+    top_level_elems << OpenStudio::Attribute.new('report', report_elems)
+
+    # create the report
+    result = OpenStudio::Attribute.new('summary_report', top_level_elems)
+    result.saveToXml(OpenStudio::Path.new('report.xml'))
+
+    # closing the sql file
+    @sql.close
+
+    # reporting final condition
+    runner.registerFinalCondition('Finished generating report.xml.')
+
+    return true
+  end
+end
+
+# this allows the measure to be use by the application
+XcelEDAReportingandQAQC.new.registerWithApplication

data/lib/measures/XcelEDAReportingandQAQC/measure.xml

@@ -0,0 +1,116 @@
+<?xml version="1.0"?>
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>xcel_eda_reportingand_qaqc</name>
+  <uid>92bee759-86ae-4617-92e2-f8e5aa9dc684</uid>
+  <version_id>1fbb6bad-30d2-4d7b-8202-9bffacab9a27</version_id>
+  <version_modified>20230606T063314Z</version_modified>
+  <xml_checksum>2C8A3EEF</xml_checksum>
+  <class_name>XcelEDAReportingandQAQC</class_name>
+  <display_name>XcelEDAReportingandQAQC</display_name>
+  <description>This measure extracts key simulation results and performs basic model QAQC checks necessary for the Xcel EDA Program.</description>
+  <modeler_description>Reads the model and sql file to pull out the necessary information and run the model checks.  The check results show up as Warning messages in the measure's output on the PAT run tab.</modeler_description>
+  <arguments />
+  <outputs />
+  <provenances />
+  <tags>
+    <tag>Reporting.QAQC</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ReportingMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Uses SketchUp API</name>
+      <value>false</value>
+      <datatype>boolean</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>0116_OfficeTest121_dev.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>63E36762</checksum>
+    </file>
+    <file>
+      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
+      <filetype>epw</filetype>
+      <usage_type>test</usage_type>
+      <checksum>BDF687C1</checksum>
+    </file>
+    <file>
+      <filename>FuelSwap.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>0331B57B</checksum>
+    </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>9640B6CB</checksum>
+    </file>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>2313289F</checksum>
+    </file>
+    <file>
+      <filename>UnmetHrs.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>A57CD713</checksum>
+    </file>
+    <file>
+      <filename>EUI.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>5048D687</checksum>
+    </file>
+    <file>
+      <filename>XcelEDAReportingandQAQC_Test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>92CFA4EC</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.0.0</identifier>
+        <min_compatible>3.6.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>1A411884</checksum>
+    </file>
+    <file>
+      <filename>PeakHeatCoolMonth.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>BF7DA333</checksum>
+    </file>
+    <file>
+      <filename>EndUseBreakdown.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>40551D0D</checksum>
+    </file>
+    <file>
+      <filename>CreateResults.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>C1E641AA</checksum>
+    </file>
+  </files>
+</measure>

data/lib/measures/{generic_qaqc → XcelEDAReportingandQAQC}/resources/CreateResults.rb

@@ -1,36 +1,6 @@
 # *******************************************************************************
-# 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:
-#
-# (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.
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
 # *******************************************************************************
 
 module OsLib_CreateResults
@@ -171,9 +141,9 @@ module OsLib_CreateResults
 
       yr = nil
       if os_version > OpenStudio::VersionString.new('1.5.3')
-        yr = "January         #{new_yr.round}"
+        yr = "January #{new_yr.round}"
       else
-        yr = "January           #{new_yr.round}"
+        yr = "January #{new_yr.round}"
       end
 
       ann_cap_cash = 0.0
@@ -288,7 +258,14 @@ module OsLib_CreateResults
     fuel_type_map = {
       OpenStudio::EndUseFuelType.new('Electricity').value => OpenStudio::FuelType.new('Electricity'),
       OpenStudio::EndUseFuelType.new('Gas').value => OpenStudio::FuelType.new('Gas'),
-      OpenStudio::EndUseFuelType.new('AdditionalFuel').value => OpenStudio::FuelType.new('Diesel'), # TODO: add other fuel types
+      OpenStudio::EndUseFuelType.new('Gasoline').value => OpenStudio::FuelType.new('Gasoline'),
+      OpenStudio::EndUseFuelType.new('Diesel').value => OpenStudio::FuelType.new('Diesel'),
+      OpenStudio::EndUseFuelType.new('Coal').value => OpenStudio::FuelType.new('Coal'), 
+      OpenStudio::EndUseFuelType.new('FuelOil_1').value => OpenStudio::FuelType.new('FuelOil_1'), 
+      OpenStudio::EndUseFuelType.new('FuelOil_2').value => OpenStudio::FuelType.new('FuelOil_2'), 
+      OpenStudio::EndUseFuelType.new('Propane').value => OpenStudio::FuelType.new('Propane'), 
+      OpenStudio::EndUseFuelType.new('OtherFuel_1').value => OpenStudio::FuelType.new('OtherFuel_1'), 
+      OpenStudio::EndUseFuelType.new('OtherFuel_2').value => OpenStudio::FuelType.new('OtherFuel_2'), 
       OpenStudio::EndUseFuelType.new('DistrictCooling').value => OpenStudio::FuelType.new('DistrictCooling'),
       OpenStudio::EndUseFuelType.new('DistrictHeating').value => OpenStudio::FuelType.new('DistrictHeating'),
       OpenStudio::EndUseFuelType.new('Water').value => OpenStudio::FuelType.new('Water')
@@ -298,7 +275,14 @@ module OsLib_CreateResults
     fuel_type_alias_map = {
       OpenStudio::EndUseFuelType.new('Electricity').value => 'electricity',
       OpenStudio::EndUseFuelType.new('Gas').value => 'gas',
-      OpenStudio::EndUseFuelType.new('AdditionalFuel').value => 'other_energy',
+      OpenStudio::EndUseFuelType.new('Gasoline').value => 'gas',
+      OpenStudio::EndUseFuelType.new('Diesel').value => 'diesel',
+      OpenStudio::EndUseFuelType.new('Coal').value => 'coal',
+      OpenStudio::EndUseFuelType.new('FuelOil_1').value => 'fuel_oil_1',
+      OpenStudio::EndUseFuelType.new('FuelOil_2').value => 'fuel_oil_2',
+      OpenStudio::EndUseFuelType.new('Propane').value => 'propane',
+      OpenStudio::EndUseFuelType.new('OtherFuel_1').value => 'other_energy',
+      OpenStudio::EndUseFuelType.new('OtherFuel_2').value => 'other_fuel_2',
       OpenStudio::EndUseFuelType.new('DistrictCooling').value => 'district_cooling',
       OpenStudio::EndUseFuelType.new('DistrictHeating').value => 'district_heating',
       OpenStudio::EndUseFuelType.new('Water').value => 'water'
@@ -331,14 +315,26 @@ module OsLib_CreateResults
     end
 
     # other_energy
-    other_energy = @sql.otherFuelTotalEndUses
-    if other_energy.is_initialized
-      cons_elems << OpenStudio::Attribute.new('other_energy', other_energy.get, 'GJ')
-      @runner.registerValue('annual_consumption_other_energy', other_energy.get, 'GJ')
-    else
-      cons_elems << OpenStudio::Attribute.new('other_energy', 0.0, 'GJ')
-      @runner.registerValue('annual_consumption_other_energy', 0.0, 'GJ')
+    other_fuels = ['gasoline', 'diesel', 'coal', 'fuelOilNo1', 'fuelOilNo2', 'propane', 'otherFuel1', 'otherFuel2']
+    other_energy_total = 0.0
+    other_fuels.each do |fuel|
+      other_energy = @sql.instance_eval(fuel + 'TotalEndUses')
+      if other_energy.is_initialized
+        # sum up all of the "other" fuels
+        other_energy_total += other_energy.get
+      end
     end
+    cons_elems << OpenStudio::Attribute.new('other_energy', other_energy_total, 'GJ')
+    @runner.registerValue('annual_consumption_other_energy', other_energy_total, 'GJ')
+
+    # other_energy = @sql.otherFuelTotalEndUses
+    # if other_energy.is_initialized
+    #   cons_elems << OpenStudio::Attribute.new('other_energy', other_energy.get, 'GJ')
+    #   @runner.registerValue('annual_consumption_other_energy', other_energy.get, 'GJ')
+    # else
+    #   cons_elems << OpenStudio::Attribute.new('other_energy', 0.0, 'GJ')
+    #   @runner.registerValue('annual_consumption_other_energy', 0.0, 'GJ')
+    # end
 
     # district_cooling
     district_cooling = @sql.districtCoolingTotalEndUses
@@ -752,7 +748,7 @@ module OsLib_CreateResults
         end
       else
         # If TOU periods were specified but this model has no district cooling, report zeroes
-        if !electricity_consumption_tou_periods.empty?
+        if electricity_consumption_tou_periods.size > 0
           # Get the TOU ids
           tou_ids = []
           electricity_consumption_tou_periods.each do |tou_pd|
@@ -882,9 +878,9 @@ module OsLib_CreateResults
     end
     if total.is_initialized
       other_val = total.get - prev_tot
-      annual_utility_cost_map[OpenStudio::EndUseFuelType.new('AdditionalFuel').valueName] = other_val
+      annual_utility_cost_map[OpenStudio::EndUseFuelType.new('OtherFuel_1').valueName] = other_val
     else
-      annual_utility_cost_map[OpenStudio::EndUseFuelType.new('AdditionalFuel').valueName] = 0.0
+      annual_utility_cost_map[OpenStudio::EndUseFuelType.new('OtherFuel_1').valueName] = 0.0
     end
 
     # export remaining costs in the correct order
@@ -892,8 +888,8 @@ module OsLib_CreateResults
     utility_cost_elems << OpenStudio::Attribute.new('gas', annual_utility_cost_map[OpenStudio::EndUseFuelType.new('Gas').valueName], 'dollars')
     @runner.registerValue('annual_utility_cost_gas', annual_utility_cost_map[OpenStudio::EndUseFuelType.new('Gas').valueName], 'dollars')
     # other_energy
-    utility_cost_elems << OpenStudio::Attribute.new('other_energy', annual_utility_cost_map[OpenStudio::EndUseFuelType.new('AdditionalFuel').valueName], 'dollars')
-    @runner.registerValue('annual_utility_cost_other_energy', annual_utility_cost_map[OpenStudio::EndUseFuelType.new('AdditionalFuel').valueName], 'dollars')
+    utility_cost_elems << OpenStudio::Attribute.new('other_energy', annual_utility_cost_map[OpenStudio::EndUseFuelType.new('OtherFuel_1').valueName], 'dollars')
+    @runner.registerValue('annual_utility_cost_other_energy', annual_utility_cost_map[OpenStudio::EndUseFuelType.new('OtherFuel_1').valueName], 'dollars')
     # district_cooling
     utility_cost_elems << OpenStudio::Attribute.new('district_cooling', annual_utility_cost_map[OpenStudio::EndUseFuelType.new('DistrictCooling').valueName], 'dollars')
     @runner.registerValue('annual_utility_cost_district_cooling', annual_utility_cost_map[OpenStudio::EndUseFuelType.new('DistrictCooling').valueName], 'dollars')
@@ -928,7 +924,12 @@ module OsLib_CreateResults
       # loop through all the fuel types
       end_use_fuel_types.each do |end_use_fuel_type|
         # get the annual total cost for this fuel type
-        ann_cost = annual_utility_cost_map[end_use_fuel_type.valueName]
+        #  Only Electricity, Gas, DistrictCooling,DistrictHeating, Water and OtherFuel_1 are defined in map so check value first
+        if annual_utility_cost_map.key?(end_use_fuel_type.valueName)
+          ann_cost = annual_utility_cost_map[end_use_fuel_type.valueName]
+        else
+          ann_cost = 0.0
+        end
         # get the total annual usage for this fuel type in all end use categories
         # loop through all end uses, adding the annual usage value to the aggregator
         ann_usg = 0.0
@@ -980,7 +981,7 @@ module OsLib_CreateResults
         fuel_type_elems = OpenStudio::AttributeVector.new
         fuel_type_name = fuel_type_alias_map[end_use_fuel_type.value]
         ann_energy_cons = 0.0
-        # in each end use, loop through months and get monthly enedy consumption
+        # in each end use, loop through months and get monthly energy consumption
         months.each_with_index do |month, i|
           mon_energy_cons = 0.0
           val = @sql.energyConsumptionByMonth(end_use_fuel_type, end_use_cat, month)

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

@@ -0,0 +1,53 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+class XcelEDAReportingandQAQC < OpenStudio::Measure::ReportingMeasure
+  # can we use E+'s metric directly?  E+ will only use conditioned area
+  # we need to incorporate building type into the range checking - ASHRAE Standard 100
+  # how many hours did the @model run for? - make sure 8760 - get from html file
+
+  # checks the EUI for the whole building
+  def eui_check
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'EUI Check')
+    check_elems << OpenStudio::Attribute.new('category', 'General')
+    check_elems << OpenStudio::Attribute.new('description', 'Check that the EUI of the building is reasonable')
+
+    building = @model.getBuilding
+
+    # make sure all required data are available
+    if @sql.totalSiteEnergy.empty?
+      check_elems << OpenStudio::Attribute.new('flag', 'Site energy data unavailable; check not run')
+      @runner.registerWarning('Site energy data unavailable; check not run')
+    end
+
+    total_site_energy_kBtu = OpenStudio.convert(@sql.totalSiteEnergy.get, 'GJ', 'kBtu').get
+    if total_site_energy_kBtu == 0
+      check_elems << OpenStudio::Attribute.new('flag', 'Model site energy use = 0; likely a problem with the model')
+      @runner.registerWarning('Model site energy use = 0; likely a problem with the model')
+    end
+
+    floor_area_ft2 = OpenStudio.convert(building.floorArea, 'm^2', 'ft^2').get
+    if floor_area_ft2 == 0
+      check_elems << OpenStudio::Attribute.new('flag', 'The building has 0 floor area')
+      @runner.registerWarning('The building has 0 floor area')
+    end
+
+    site_EUI = total_site_energy_kBtu / floor_area_ft2
+    if site_EUI > 200
+      check_elems << OpenStudio::Attribute.new('flag', "Site EUI of #{site_EUI} looks high.  A hospital or lab (high energy buildings) are around 200 kBtu/ft^2")
+      @runner.registerWarning("Site EUI of #{site_EUI} looks high.  A hospital or lab (high energy buildings) are around 200 kBtu/ft^2")
+    end
+    if site_EUI < 30
+      check_elems << OpenStudio::Attribute.new('flag', "Site EUI of #{site_EUI} looks low.  A high efficiency office building is around 50 kBtu/ft^2")
+      @runner.registerWarning("Site EUI of #{site_EUI} looks low.  A high efficiency office building is around 50 kBtu/ft^2")
+    end
+
+    check_elem = OpenStudio::Attribute.new('check', check_elems)
+
+    return check_elem
+  end
+ end

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

@@ -0,0 +1,88 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+class XcelEDAReportingandQAQC < OpenStudio::Measure::ReportingMeasure
+  # add electric heat rejection to electric cooling
+  # add fans and lights? compare fans and cooling - greater than 5x different during peak cooling month - helps identify bad chiller curves
+
+  # energy use for cooling and heating as percentage of total energy
+  def enduse_pcts_check
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'Energy Enduses Check')
+    check_elems << OpenStudio::Attribute.new('category', 'Xcel EDA')
+    check_elems << OpenStudio::Attribute.new('description', 'Check that heating and cooling energy make up the expected percentage of total energy consumption')
+
+    # aggregators to hold the values
+    electricity_cooling = 0
+    natural_gas_cooling = 0
+    other_fuel_cooling = 0
+    total_site_energy = 0
+    electricity_heating = 0
+    natural_gas_heating = 0
+    other_fuel_heating = 0
+
+    # make sure all required data are available
+    if @sql.electricityCooling.is_initialized
+      electricity_cooling = @sql.electricityCooling.get
+    end
+    if @sql.naturalGasCooling.is_initialized
+      natural_gas_cooling = @sql.naturalGasCooling.get
+    end
+    if @sql.totalSiteEnergy.is_initialized
+      total_site_energy = @sql.totalSiteEnergy.get
+    end
+    if @sql.electricityHeating.is_initialized
+      electricity_heating = @sql.electricityHeating.get
+    end
+    if @sql.naturalGasHeating.is_initialized
+      natural_gas_heating = @sql.naturalGasHeating.get
+    end
+
+    other_fuels = ['gasoline', 'diesel', 'coal', 'fuelOilNo1', 'fuelOilNo2', 'propane', 'otherFuel1', 'otherFuel2']
+    other_fuel_cooling = 0.0
+    other_fuels.each do |fuel|
+      other_energy = @sql.instance_eval(fuel + 'Cooling')
+      if other_energy.is_initialized
+        # sum up all of the "other" fuels
+        other_fuel_cooling += other_energy.get
+      end
+    end
+    other_fuel_heating = 0.0
+    other_fuels.each do |fuel|
+      other_energy = @sql.instance_eval(fuel + 'Heating')
+      if other_energy.is_initialized
+        # sum up all of the "other" fuels
+        other_fuel_heating += other_energy.get
+      end
+    end
+
+    # if @sql.otherFuelCooling.is_initialized
+      # other_fuel_cooling = @sql.otherFuelCooling.get
+    # end
+    # if @sql.otherFuelHeating.is_initialized
+      # other_fuel_heating = @sql.otherFuelHeating.get
+    # end
+
+    pct_cooling = (electricity_cooling + natural_gas_cooling + other_fuel_cooling) / total_site_energy
+    pct_heating = (electricity_heating + natural_gas_heating + other_fuel_heating) / total_site_energy
+
+    # flag if 0% < pct_cooling < 20%
+    if (pct_cooling < 0.0) || (pct_cooling > 0.2)
+      check_elems << OpenStudio::Attribute.new('flag', "Cooling energy = #{pct_cooling} of total energy use;  outside of 0%-20% range expected by Xcel EDA")
+      @runner.registerWarning("Cooling energy = #{pct_cooling} of total energy use;  outside of 0%-20% range expected by Xcel EDA")
+    end
+
+    # flag if 30% < pct_heating < 50%
+    if (pct_heating < 0.30) || (pct_heating > 0.50)
+      check_elems << OpenStudio::Attribute.new('flag', "Heating energy = #{pct_heating} of total energy use; outside the 30%-50% range expected by Xcel EDA")
+      @runner.registerWarning("Heating energy = #{pct_heating} of total energy use; outside the 30%-50% range expected by Xcel EDA")
+    end
+
+    check_elem = OpenStudio::Attribute.new('check', check_elems)
+
+    return check_elem
+  end
+end