openstudio-extension 0.1.0 → 0.1.1

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

@@ -0,0 +1,158 @@
+# *******************************************************************************
+# 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_simultaneous_heating_and_cooling(category, max_pass, name_only = false)
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'Simultaneous Heating and Cooling')
+    check_elems << OpenStudio::Attribute.new('category', category)
+    check_elems << OpenStudio::Attribute.new('description', 'Check for simultaneous heating and cooling by looping through all Single Duct VAV Reheat Air Terminals and analyzing hourly data when there is a cooling load. ')
+
+    # 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
+
+    begin
+      # get the weather file run period (as opposed to design day run period)
+      ann_env_pd = nil
+      @sql.availableEnvPeriods.each do |env_pd|
+        env_type = @sql.environmentType(env_pd)
+        if env_type.is_initialized
+          if env_type.get == OpenStudio::EnvironmentType.new('WeatherRunPeriod')
+            ann_env_pd = env_pd
+            break
+          end
+        end
+      end
+
+      # only try to get the annual timeseries if an annual simulation was run
+      if ann_env_pd.nil?
+        check_elems << OpenStudio::Attribute.new('flag', 'Cannot find the annual simulation run period, cannot determine simultaneous heating and cooling.')
+        return check_elem
+      end
+
+      # For each VAV reheat terminal, calculate
+      # the annual total % reheat hours.
+      @model.getAirTerminalSingleDuctVAVReheats.each do |term|
+        # Reheat coil heating rate
+        rht_coil = term.reheatCoil
+        key_value =  rht_coil.name.get.to_s.upcase # must be in all caps.
+        time_step = 'Hourly' # "Zone Timestep", "Hourly", "HVAC System Timestep"
+        variable_name = 'Heating Coil Heating Rate'
+        variable_name_alt = 'Heating Coil Air Heating Rate'
+        rht_rate_ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value) # key value would go at the end if we used it.
+
+        # try and alternate variable name
+        if rht_rate_ts.empty?
+          rht_rate_ts = @sql.timeSeries(ann_env_pd, time_step, variable_name_alt, key_value) # key value would go at the end if we used it.
+        end
+
+        if rht_rate_ts.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "Heating Coil (Air) Heating Rate Timeseries not found for #{key_value}.")
+        else
+
+          rht_rate_ts = rht_rate_ts.get.values
+          # Put timeseries into array
+          rht_rate_vals = []
+          for i in 0..(rht_rate_ts.size - 1)
+            rht_rate_vals << rht_rate_ts[i]
+          end
+
+          # Zone Air Terminal Sensible Heating Rate
+          key_value = "ADU #{term.name.get.to_s.upcase}" # must be in all caps.
+          time_step = 'Hourly' # "Zone Timestep", "Hourly", "HVAC System Timestep"
+          variable_name = 'Zone Air Terminal Sensible Cooling Rate'
+          clg_rate_ts = @sql.timeSeries(ann_env_pd, time_step, variable_name, key_value) # key value would go at the end if we used it.
+          if clg_rate_ts.empty?
+            check_elems << OpenStudio::Attribute.new('flag', "Zone Air Terminal Sensible Cooling Rate Timeseries not found for #{key_value}.")
+          else
+
+            clg_rate_ts = clg_rate_ts.get.values
+            # Put timeseries into array
+            clg_rate_vals = []
+            for i in 0..(clg_rate_ts.size - 1)
+              clg_rate_vals << clg_rate_ts[i]
+            end
+
+            # Loop through each timestep and calculate the hourly
+            # % reheat value.
+            ann_rht_hrs = 0
+            ann_clg_hrs = 0
+            ann_pcts = []
+            rht_rate_vals.zip(clg_rate_vals).each do |rht_w, clg_w|
+              # Skip hours with no cooling (in heating mode)
+              next if clg_w == 0
+              pct_overcool_rht = rht_w / (rht_w + clg_w)
+              ann_rht_hrs += pct_overcool_rht # implied * 1hr b/c hrly results
+              ann_clg_hrs += 1
+              ann_pcts << pct_overcool_rht.round(3)
+            end
+
+            # Calculate annual % reheat hours
+            ann_pct_reheat = ((ann_rht_hrs / ann_clg_hrs) * 100).round(1)
+
+            # Compare to limit
+            if ann_pct_reheat > max_pass * 100.0
+              check_elems << OpenStudio::Attribute.new('flag', "#{term.name} has #{ann_pct_reheat}% overcool-reheat, which is greater than the limit of #{max_pass * 100.0}%. This terminal is in cooling mode for #{ann_clg_hrs} hours of the year.")
+            end
+
+          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_supply_air_and_thermostat_temp_difference.rb

@@ -0,0 +1,148 @@
+# *******************************************************************************
+# 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_supply_air_and_thermostat_temp_difference(category, target_standard, max_delta, name_only = false)
+    # G3.1.2.9 requires a 20 degree F delta between supply air temperature and zone temperature.
+    target_clg_delta = 20.0
+
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'Supply and Zone Air Temperature')
+    check_elems << OpenStudio::Attribute.new('category', category)
+    if @utility_name.nil?
+      check_elems << OpenStudio::Attribute.new('description', "Check if fans modeled to ASHRAE 90.1 2013 Section G3.1.2.9 requirements. Compare the supply air temperature for each thermal zone against the thermostat setpoints. Throw flag if temperature difference excedes threshold of #{target_clg_delta}F plus the selected tolerance.")
+    else
+      check_elems << OpenStudio::Attribute.new('description', "Check if fans modeled to ASHRAE 90.1 2013 Section G3.1.2.9 requirements. Compare the supply air temperature for each thermal zone against the thermostat setpoints. Throw flag if temperature difference excedes threshold set by #{@utility_name}.")
+    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
+      # loop through thermal zones
+      @model.getThermalZones.sort.each do |thermal_zone|
+        model_clg_min = nil
+
+        # populate thermostat ranges
+        if thermal_zone.thermostatSetpointDualSetpoint.is_initialized
+
+          thermostat = thermal_zone.thermostatSetpointDualSetpoint.get
+          if thermostat.coolingSetpointTemperatureSchedule.is_initialized
+
+            clg_sch = thermostat.coolingSetpointTemperatureSchedule.get
+            schedule_values = nil
+            if clg_sch.to_ScheduleRuleset.is_initialized
+              if use_old_gem_code
+                schedule_values = clg_sch.to_ScheduleRuleset.get.annual_min_max_value
+              else
+                schedule_values = std.schedule_ruleset_annual_min_max_value(clg_sch.to_ScheduleRuleset.get)
+              end
+            elsif clg_sch.to_ScheduleConstant.is_initialized
+              if use_old_gem_code
+                schedule_values = clg_sch.to_ScheduleConstant.get.annual_min_max_value
+              else
+                schedule_values = std.schedule_constant_annual_min_max_value(clg_sch.to_ScheduleConstant.get)
+              end
+            end
+
+            unless schedule_values.nil?
+              model_clg_min = schedule_values['min']
+            end
+          end
+
+        else
+          # go to next zone if not conditioned
+          next
+
+        end
+
+        # flag if there is setpoint schedule can't be inspected (isn't ruleset)
+        if model_clg_min.nil?
+          check_elems << OpenStudio::Attribute.new('flag', "Can't inspect thermostat schedules for #{thermal_zone.name}")
+        else
+
+          # get supply air temps from thermal zone sizing
+          sizing_zone = thermal_zone.sizingZone
+          clg_supply_air_temp = sizing_zone.zoneCoolingDesignSupplyAirTemperature
+
+          # convert model values to IP
+          model_clg_min_ip = OpenStudio.convert(model_clg_min, 'C', 'F').get
+          clg_supply_air_temp_ip = OpenStudio.convert(clg_supply_air_temp, 'C', 'F').get
+
+          # check supply air against zone temperature (only check against min setpoint, assume max is night setback)
+          if model_clg_min_ip - clg_supply_air_temp_ip > target_clg_delta + max_delta
+            check_elems << OpenStudio::Attribute.new('flag', "For #{thermal_zone.name} the delta temp between the cooling supply air temp of #{clg_supply_air_temp_ip.round(2)} (F) and the minimum thermostat cooling temp of #{model_clg_min_ip.round(2)} (F) is more than #{max_delta} (F) larger than the expected delta of #{target_clg_delta} (F)")
+          elsif model_clg_min_ip - clg_supply_air_temp_ip < target_clg_delta - max_delta
+            check_elems << OpenStudio::Attribute.new('flag', "For #{thermal_zone.name} the delta temp between the cooling supply air temp of #{clg_supply_air_temp_ip.round(2)} (F) and the minimum thermostat cooling temp of #{model_clg_min_ip.round(2)} (F) is more than #{max_delta} (F) smaller than the expected delta of #{target_clg_delta} (F)")
+          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_weather_files.rb

@@ -0,0 +1,132 @@
+# *******************************************************************************
+# 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_weather_files(category, options, name_only = false)
+    # summary of the check
+    check_elems = OpenStudio::AttributeVector.new
+    check_elems << OpenStudio::Attribute.new('name', 'Weather Files')
+    check_elems << OpenStudio::Attribute.new('category', category)
+    check_elems << OpenStudio::Attribute.new('description', "Check weather file, design days, and climate zone against #{@utility_name} list of allowable options.")
+
+    # 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
+
+    begin
+      # get weather file
+      model_epw = nil
+      if @model.getWeatherFile.url.is_initialized
+        raw_epw = @model.getWeatherFile.url.get
+        end_path_index = raw_epw.rindex('/')
+        model_epw = raw_epw.slice!(end_path_index + 1, raw_epw.length) # everything right of last forward slash
+      end
+
+      # check design days (model must have one or more of the required summer and winter design days)
+      # get design days names from model
+      model_summer_dd_names = []
+      model_winter_dd_names = []
+      @model.getDesignDays.each do |design_day|
+        if design_day.dayType == 'SummerDesignDay'
+          model_summer_dd_names << design_day.name.to_s
+        elsif design_day.dayType == 'WinterDesignDay'
+          model_winter_dd_names << design_day.name.to_s
+        else
+          puts "unexpected day type of #{design_day.dayType} wont' be included in check"
+        end
+      end
+
+      # find matching weather file from options, as well as design days and climate zone
+      if options.key?(model_epw)
+        required_summer_dd = options[model_epw]['summer']
+        required_winter_dd = options[model_epw]['winter']
+        valid_climate_zones = [options[model_epw]['climate_zone']]
+
+        # check for intersection betwen model valid design days
+        summer_intersection = (required_summer_dd & model_summer_dd_names)
+        winter_intersection = (required_winter_dd & model_winter_dd_names)
+        if summer_intersection.empty? && !required_summer_dd.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "Didn't find any of the expected summer design days for #{model_epw}")
+        end
+        if winter_intersection.empty? && !required_winter_dd.empty?
+          check_elems << OpenStudio::Attribute.new('flag', "Didn't find any of the expected winter design days for #{model_epw}")
+        end
+
+      else
+        check_elems << OpenStudio::Attribute.new('flag', "#{model_epw} is not a an expected weather file.")
+        check_elems << OpenStudio::Attribute.new('flag', "Model doesn't have expected epw file, as a result can't validate design days.")
+        valid_climate_zones = []
+        options.each do |lookup_epw, value|
+          valid_climate_zones << value['climate_zone']
+        end
+      end
+
+      # get ashrae climate zone from model
+      model_climate_zone = nil
+      climateZones = @model.getClimateZones
+      climateZones.climateZones.each do |climateZone|
+        if climateZone.institution == 'ASHRAE'
+          model_climate_zone = climateZone.value
+          next
+        end
+      end
+      if model_climate_zone == ''
+        check_elems << OpenStudio::Attribute.new('flag', "The model's ASHRAE climate zone has not been defined. Expected climate zone was #{valid_climate_zones.uniq.join(',')}.")
+      elsif !valid_climate_zones.include?(model_climate_zone)
+        check_elems << OpenStudio::Attribute.new('flag', "The model's ASHRAE climate zone was #{model_climate_zone}. Expected climate zone was #{valid_climate_zones.uniq.join(',')}.")
+      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/deer_vintages.rb

@@ -0,0 +1,311 @@
+# *******************************************************************************
+# 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.
+# *******************************************************************************
+
+# Maps the DEER vintages to year ranges
+module DEERVintages
+  # Building type abbreviation to long name map
+  def building_type_to_long
+    return {
+      'Asm' => 'Assembly',
+      'DMo' => 'Residential Mobile Home',
+      'ECC' => 'Education - Community College',
+      'EPr' => 'Education - Primary School',
+      'ERC' => 'Education - Relocatable Classroom',
+      'ESe' => 'Education - Secondary School',
+      'EUn' => 'Education - University',
+      'GHs' => 'Greenhouse',
+      'Gro' => 'Grocery',
+      'Hsp' => 'Health/Medical - Hospital',
+      'Htl' => 'Lodging - Hotel',
+      'MBT' => 'Manufacturing Biotech',
+      'MFm' => 'Residential Multi-family',
+      'MLI' => 'Manufacturing Light Industrial',
+      'Mtl' => 'Lodging - Motel',
+      'Nrs' => 'Health/Medical - Nursing Home',
+      'OfL' => 'Office - Large',
+      'OfS' => 'Office - Small',
+      'RFF' => 'Restaurant - Fast-Food',
+      'RSD' => 'Restaurant - Sit-Down',
+      'Rt3' => 'Retail - Multistory Large',
+      'RtL' => 'Retail - Single-Story Large',
+      'RtS' => 'Retail - Small',
+      'SCn' => 'Storage - Conditioned',
+      'SFm' => 'Residential Single Family',
+      'SUn' => 'Storage - Unconditioned',
+      'WRf' => 'Warehouse - Refrigerated'
+    }
+  end
+
+  # HVAC type abbreviation to long name map
+  def hvac_sys_to_long
+    return {
+      'DXGF' => 'Split or Packaged DX Unit with Gas Furnace',
+      'DXEH' => 'Split or Packaged DX Unit with Electric Heat',
+      'DXHP' => 'Split or Packaged DX Unit with Heat Pump',
+      'WLHP' => 'Water Loop Heat Pump',
+      'NCEH' => 'No Cooling with Electric Heat',
+      'NCGF' => 'No Cooling with Gas Furnace',
+      'PVVG' => 'Packaged VAV System with Gas Boiler',
+      'PVVE' => 'Packaged VAV System with Electric Heat',
+      'SVVG' => 'Built-Up VAV System with Gas Boiler',
+      'SVVE' => 'Built-Up VAV System with Electric Reheat',
+      'Unc' => 'No HVAC (Unconditioned)',
+      'PTAC' => 'Packaged Terminal Air Conditioner',
+      'PTHP' => 'Packaged Terminal Heat Pump',
+      'FPFC' => 'Four Pipe Fan Coil',
+      'DDCT' => 'Dual Duct System',
+      'EVAP' => 'Evaporative Cooling with Separate Gas Furnace'
+    }
+  end
+
+  # Valid building type/hvac type combos
+  def building_type_to_hvac_systems
+    return {
+      'Asm' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF'
+      ],
+      'ECC' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF',
+        'PVVE',
+        'PVVG',
+        'SVVE',
+        'SVVG',
+        'WLHP'
+      ],
+      'EPr' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF',
+        'WLHP'
+      ],
+      'ERC' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF'
+      ],
+      'ESe' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF',
+        'PVVE',
+        'PVVG',
+        'SVVE',
+        'SVVG',
+        'WLHP'
+      ],
+      'EUn' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF',
+        'PVVE',
+        'PVVG',
+        'SVVE',
+        'SVVG'
+      ],
+      'Gro' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF'
+      ],
+      'Hsp' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF',
+        'PVVE',
+        'PVVG',
+        'SVVE',
+        'SVVG'
+      ],
+      'Nrs' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'FPFC',
+        'NCEH',
+        'NCGF',
+        'PVVE',
+        'PVVG',
+        'SVVE',
+        'SVVG'
+      ],
+      'Htl' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF',
+        'PVVE',
+        'PVVG',
+        'SVVE',
+        'SVVG',
+        'WLHP'
+      ],
+      'Mtl' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF'
+      ],
+      'MBT' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF',
+        'PVVE',
+        'PVVG',
+        'SVVE',
+        'SVVG',
+        'WLHP'
+      ],
+      'MLI' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF'
+      ],
+      'OfL' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF',
+        'PVVE',
+        'PVVG',
+        'SVVE',
+        'SVVG',
+        'WLHP'
+      ],
+      'OfS' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF',
+        'PVVE',
+        'PVVG',
+        'SVVE',
+        'SVVG',
+        'WLHP'
+      ],
+      'RFF' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF'
+      ],
+      'RSD' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF'
+      ],
+      'Rt3' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF',
+        'PVVE',
+        'PVVG',
+        'SVVE',
+        'SVVG',
+        'WLHP'
+      ],
+      'RtL' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF'
+      ],
+      'RtS' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF'
+      ],
+      'SCn' => [
+        'DXEH',
+        'DXGF',
+        'DXHP',
+        'NCEH',
+        'NCGF'
+      ],
+      'SUn' => ['Unc'],
+      'WRf' => ['DXGF']
+    }
+  end
+
+  # Age range to DEER template
+  def template_to_age_range
+    return {
+      'DEER Pre-1975' => 'Before 1978',
+      'DEER 1985' => '1978-1992',
+      'DEER 1996' => '1993-2001',
+      'DEER 2003' => '2002-2005',
+      'DEER 2007' => '2006-2009',
+      'DEER 2011' => '2010-2013',
+      'DEER 2014' => '2014',
+      'DEER 2015' => '2015-2016',
+      'DEER 2017' => '2017 or Later'
+    }
+  end
+end