openstudio-extension 0.1.2 → 0.1.3

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

@@ -1,132 +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
+# *******************************************************************************
+# 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

@@ -1,311 +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
+# *******************************************************************************
+# 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