openstudio-standards 0.6.3 → 0.7.0.rc1

data/lib/openstudio-standards/standards/necb/docs/air_system_names_method.md

@@ -0,0 +1,127 @@
+The systax used for air system names in BTAP is:  
+
+**sys_abbr|oa|shr>?|sc>?|sh>?|ssf?|zh>?|zc>?|srf>?**
+
+# Field "sys_abbr"  
+
+## Description  
+System type abbrevation  
+## Values  
+"sys_1", "sys_2", ..., "sys_6" for NECB
+
+# Field "oa"  
+## Description  
+Indicates whether there is return air in the supply air  
+## Values  
+1. "doas": dedicated-outdoor air system
+2. "mixed": system with return air in supply air  
+
+# Field "shr>?"  
+## Description  
+Type of heat recovery  
+## Values  
+1. "none": no heat recovery  
+2. "erv":  energy recovery device (sensible+latent)
+
+# Field "sc>?"  
+## Description  
+System cooling equipment  
+## Values  
+1. "none": no cooling equipment  
+2. "c-chw":  coil-chilled-water  
+3. "dx":     direct-expansion  
+4. "ccashp": cold-climate air-source heat pump  
+5. "ashp":   air-source heat pump
+
+# Field "sh>?"
+## Description  
+Primary and backup heating equipment  
+## Values  
+1.  "none":        no heating equipment  
+2.  "c-e":         coil-electric  
+3.  "c-hw":        coil-hot-water  
+4.  "c-g":         coil-gas  
+5.  "ccashp":      cold-climate air-source heat pump
+6.  "ccashp>c-e":  cold-climate air-source heat pump with electric coil backup
+7.  "ccashp>c-g":  cold-climate air-source heat pump with natural gas coil backup
+8.  "ccashp>c-hw": cold-climate air-source heat pump with hot-water coil backup" 
+9.  "ashp":        air-source heat pump
+10. "ashp>c-e":    air-source heat pump with electric coil backup
+11. "ashp>c-g":    air-source heat pump with natural gas coil backup
+12. "ashp>c-hw":   air-source heat pump with hot-water coil backup" 
+
+# Field "ssf>?"  
+## Description  
+System supply fan  
+## Values  
+1. "cv": constant-volume  
+2. "vv": variable-volume  
+
+# Field "zh>?"
+## Description  
+Zone heating equipment
+## Values  
+1.  "none":      no zone heating
+2.  "b-e":       baseboard electric  
+3.  "b-hw":      baseboard hot-water
+4.  "tpfc":      two-pipe fan coil  
+5.  "fpfc":      four-pipe fan coil  
+6.  "pthp":      packaged-terminal heat pump
+7.  "pthp>c-e":  packaged-terminal heat pump with electric coil backup
+8.  "pthp>c-g":  packaged-terminal heat pump with natural gas coil backup
+9.  "pthp>c-hw": packaged-terminal heat pump with hot-water coil backup
+10. "vrf":       variable-refrigerant flow 
+11. "vrf>c-e":   variable-refrigerant flow with electric coil backup
+12. "vrf>c-hw":   variable-refrigerant flow with hot-water coil backup
+
+# Field "zc>?"  
+# Desciption  
+Zone cooling equipment  
+## Values  
+1. "none": no zone cooling  
+2. "tpfc": two-pipe fan coil  
+3. "fpfc": four-pipe fan coil  
+4. "ptac": packaged-terminal air-conditioner 
+5. "pthp": packaged-terminal heat-pump  
+6. "vrf":  variable-refrigerant flow  
+
+# Field "srf>?"  
+## Description  
+System return fan  
+## Values  
+1. "cv": constant-volume  
+2. "vv": variable-volume  
+
+# Examples of System Names  
+
+sys_1|doas|shr>erv|sc>dx|sh>c-e|ssf>cv|zh>b-e|zc>ptac|srf>none  
+sys_1|doas|shr>erv|sc>dx|sh>c-e|ssf>cv|zh>b-hw|zc>ptac|srf>none  
+sys_1|doas|shr>erv|sc>dx|sh>c-hw|ssf>cv|zh>b-e|zc>ptac|srf>none  
+sys1|doas|shr>erv|sc>dx|sh>c-hw|ssf>cv|zh>b-hw|zc>ptac|srf>none  
+sys1|doas|shr>erv|sc>ashp|sh>ashp>c-e|ssf>cv|zh>b-e|zc>ptac|srf>none  
+
+sys_1|doas|shr>erv|sc>dx|sh>c-g|ssf>cv|zh>tpfc|zc>fpfc|srf>none  
+sys_1|doas|shr>erv|sc>c-chw|sh>c-g|ssf>cv|zh>tpfc|zc>fpfc|srf>none  
+sys_1|doas|shr>erv|sc>ashp|sh>ashp>c-e|ssf>cv|zh>tpfc|zc>fpfc|srf>none  
+
+sys_3|mixed|shr>erv|sc>dx|sh>c-e|ssf>cv|zc>none|zh>b-e|srf>none  
+sys_3|mixed|shr>erv|sc>dx|sh>c-e|ssf>cv|zc>none|zh>b-hw|srf>none  
+sys_3|mixed|shr>erv|sc>dx|sh>c-hw|ssf>cv|zc>none|zh>b-e|srf>none  
+sys_3|mixed|shr>erv|sc>dx|sh>c-hw|ssf>cv|zc>none|zh>b-hw|srf>none  
+sys_3|mixed|shr>erv|sc>ashp|sh>ashp>c-e|ssf>cv|zc>none|zh>b-e|srf>none  
+
+sys_4|mixed|shr>erv|sc>dx|sh>c-e|ssf>cv|zc>none|zh>b-e|srf>none  
+sys_4|mixed|shr>erv|sc>dx|sh>c-e|ssf>cv|zc>none|zh>b-hw|srf>none  
+sys_4|mixed|shr>erv|sc>dx|sh>c-g|ssf>cv|zc>none|zh>b-e|srf>none  
+sys_4|mixed|shr>erv|sc>dx|sh>c-g|ssf>cv|zc>none|zh>b-hw|srf>none  
+sys_4|mixed|shr>erv|sc>ashp|sh>ashp>c-e|ssf>cv|zc>none|zh>b-e|srf>none  
+
+sys_5|doas|shr>erv|sc>dx|sh>c-g|ssf>cv|zc>tpfc|zh>tpfc|srf>none  
+sys_5|doas|shr>erv|sc>c-chw|sh>c-g|ssf>cv|zc>tpfc|zh>tpfc|srf>none  
+sys_5|doas|shr>erv|sc>ashp|sh>ashp>c-e|ssf>cv|zc>tpfc|zh>tpfc|srf>none  
+
+sys_6|mixed|shr>erv|sc>c-chw|sh>c-e|ssf>vv|zc>none|zh>b-e|srf>vv  
+sys_6|mixed|shr>erv|sc>c-chw|sh>c-e|ssf>vv|zc>none|zh>b-hw|srf>vv  
+sys_6|mixed|shr>erv|sc>c-chw|sh>c-hw|ssf>vv|zc>none|zh>b-e|srf>vv  
+sys_6|mixed|shr>erv|sc>c-chw|sh>c-hw|ssf>vv|zc>none|zh>b-hw|srf>vv  
+sys_6|mixed|shr>erv|sc>ashp|sh>ashp>c-e|ssf>vv|zc>none|zh>b-hw|srf>vv  

data/lib/openstudio-standards/thermal_zone/thermal_zone.rb

@@ -1,5 +1,5 @@
-# Methods to obtain information about model spaces
 module OpenstudioStandards
+  # The ThermalZone module provides methods get information about model thermal zones
   module ThermalZone
     # Determine if the thermal zone is a plenum based on whether a majority of the spaces in the zone are plenums or not.
     #

data/lib/openstudio-standards/utilities/template_measure/resources/BTAPMeasureHelper.rb

@@ -297,7 +297,7 @@ module BTAPMeasureTestHelper
 
   # helper method to create necb archetype as a starting point for testing.
   def create_necb_protype_model(building_type, climate_zone, epw_file, template)
-    osm_directory = "#{Dir.pwd}/output/#{building_type}-#{template}-#{climate_zone}-#{epw_file}"
+    osm_directory = "#{__dir__}/output/#{building_type}-#{template}-#{climate_zone}-#{epw_file}"
     FileUtils.mkdir_p(osm_directory)
 
     # Set building location from epw file

data/lib/openstudio-standards/version.rb

@@ -13,5 +13,5 @@ module OpenstudioStandards
     end
     return 'git-not-found-on-this-system'
   end
-  VERSION = '0.6.3'.freeze
+  VERSION = '0.7.0.rc1'.freeze
 end

data/lib/openstudio-standards/weather/information.rb

@@ -170,7 +170,7 @@ module OpenstudioStandards
             full_epw_path = OpenStudio::OptionalPath.new(epw_path.get)
           else
             # If this is an always-run Measure, need to check a different path
-            alt_weath_path = File.expand_path(File.join(Dir.pwd, '../../resources'))
+            alt_weath_path = File.expand_path(File.join(__dir__, '../../resources'))
             alt_epw_path = File.expand_path(File.join(alt_weath_path, epw_path.get.to_s))
             if File.exist?(alt_epw_path)
               full_epw_path = OpenStudio::OptionalPath.new(OpenStudio::Path.new(alt_epw_path))
@@ -202,7 +202,7 @@ module OpenstudioStandards
         stat_string = load_resource_relative("../../../data/weather/#{weather_file_name.gsub('.epw', '.stat')}")
 
         # extract to local weather dir
-        weather_dir = File.expand_path(File.join(Dir.pwd, 'extracted_files/weather/'))
+        weather_dir = File.expand_path(File.join(__dir__, 'extracted_files/weather/'))
         OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.Weather.information', "Extracting weather files from OpenStudio CLI to #{weather_dir}")
         FileUtils.mkdir_p(weather_dir)
 
@@ -453,10 +453,66 @@ module OpenstudioStandards
     # @param base_humidity_ratio [Double] base humidity ratio, default is 0.010
     # @return [Double] dehumdification degree days
     def self.epw_file_get_dehumidification_degree_days(epw_file, base_humidity_ratio: 0.010)
-      db_temps_c = epw_file.getTimeSeries('Dry Bulb Temperature').get.values
+      # Workaround for case when the weather file contains the February from a leap year but that February only has 28
+      # days of data.
+      has_leap_day = false
+
+      # Find the first day in February
+      feb_index = epw_file.data.find_index { |entry| entry.date.monthOfYear.value == 2 }
+
+      # Find the year for February
+      feb_year = epw_file.data[feb_index].year
+      # Determine if February's year is a leap year
+      leap_year = false
+      if (feb_year % 100) > 0
+        leap_year = true if (feb_year % 4) == 0
+      else
+        leap_year = true if (feb_year % 400) == 0
+      end
+      # If the February is from a leap year determine if it contains a leap day
+      if leap_year
+
+        day = epw_file.data[feb_index].date.dayOfMonth
+        inc = 0
+
+        while epw_file.data[feb_index].date.dayOfMonth == day
+          feb_index += 1
+          inc       += 1
+        end
+
+        has_leap_day = epw_file.data[feb_index + (inc * 28)].date.dayOfMonth == 29
+      end
+
+      # If the February is from a leap year and there is no leap day then do not use the faulty OpenStudio Epw
+      # .getTimeSeries method.  Otherwise, use the method.
+      if has_leap_day || !leap_year
+        db_temps_c   = epw_file.getTimeSeries('Dry Bulb Temperature').get.values
+        rh_values    = epw_file.getTimeSeries('Relative Humidity').get.values
+        atm_p_values = epw_file.getTimeSeries('Atmospheric Station Pressure').get.values
+      else
+        # Access the data directly instead of using the OpenStudio API to avoid the faulty OpenStudioEpw
+        # .getTimeSeries method.
+
+        # Open the weather file
+        regex_csv = /[^,]+/
+        regex_num = /[0-9]/
+        f         = File.open(epw_file.path.to_s, 'r')
+        i         = 0
+
+        # Skip the header
+        i += 1 until f.readline[0] =~ regex_num
+
+        # Get all of the hourly weather data
+        lines         = IO.readlines(f)[i..-1]
+
+        # Get hourly weather data for a specific column
+        db_temps_c    = lines.map { |line| Float(line.scan(regex_csv)[6]) }
+        rh_values     = lines.map { |line| Float(line.scan(regex_csv)[8]) }
+        atm_p_values  = lines.map { |line| Float(line.scan(regex_csv)[9]) }
+      end
+
       db_temps_k = db_temps_c.map { |v| v + 273.15 }
-      rh_values = epw_file.getTimeSeries('Relative Humidity').get.values
-      atm_p_values = epw_file.getTimeSeries('Atmospheric Station Pressure').get.values
+
 
       # coefficients for the calculation of pws (Reference: ASHRAE Handbook - Fundamentals > CHAPTER 1. PSYCHROMETRICS)
       c1 = -5.6745359E+03

data/lib/openstudio-standards/weather/modify.rb

@@ -147,7 +147,7 @@ module OpenstudioStandards
             full_epw_path = epw_path.get.to_s
           else
             # If this is an always-run Measure, need to check a different path
-            alt_weath_path = File.expand_path(File.join(Dir.pwd, '../../resources'))
+            alt_weath_path = File.expand_path(File.join(__dir__, '../../resources'))
             alt_epw_path = File.expand_path(File.join(alt_weath_path, epw_path.get.to_s))
             if File.exist?(alt_epw_path)
               full_epw_path = alt_epw_path

data/lib/openstudio-standards.rb

@@ -36,7 +36,10 @@ module OpenstudioStandards
   require_relative 'openstudio-standards/schedules/parametric'
 
   # ServiceWaterHeating Module
-  require_relative 'openstudio-standards/service_water_heating/component'
+  require_relative 'openstudio-standards/service_water_heating/create_piping_losses'
+  require_relative 'openstudio-standards/service_water_heating/create_water_heater'
+  require_relative 'openstudio-standards/service_water_heating/create_water_heating_loop'
+  require_relative 'openstudio-standards/service_water_heating/create_water_use'
 
   # Space Module
   require_relative 'openstudio-standards/space/space'
@@ -269,6 +272,7 @@ module OpenstudioStandards
   require_relative "#{stds}/Standards.PumpConstantSpeed"
   require_relative "#{stds}/Standards.PumpVariableSpeed"
   require_relative "#{stds}/Standards.ScheduleRuleset"
+  require_relative "#{stds}/Standards.ServiceWaterHeating"
   require_relative "#{stds}/Standards.Space"
   require_relative "#{stds}/Standards.SpaceType"
   require_relative "#{stds}/Standards.SubSurface"
@@ -515,11 +519,9 @@ module OpenstudioStandards
   require_relative "#{proto}/common/objects/Prototype.Model.exterior_lights"
   require_relative "#{proto}/common/objects/Prototype.Model.hvac"
   require_relative "#{proto}/common/objects/Prototype.Model"
-  require_relative "#{proto}/common/objects/Prototype.Model.swh"
   require_relative "#{proto}/common/objects/Prototype.Pump"
   require_relative "#{proto}/common/objects/Prototype.PumpVariableSpeed"
   require_relative "#{proto}/common/objects/Prototype.refrigeration"
-  require_relative "#{proto}/common/objects/Prototype.ServiceWaterHeating"
   require_relative "#{proto}/common/objects/Prototype.SizingSystem"
   require_relative "#{proto}/common/objects/Prototype.utilities"
   # 90.1-2004

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-standards
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0.rc1
 platform: ruby
 authors:
 - Mark Adams
@@ -39,7 +39,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-04 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,20 +83,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.7.0
-- !ruby/object:Gem::Dependency
-  name: aes
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -111,20 +97,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: google_drive
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -209,34 +181,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.2
-- !ruby/object:Gem::Dependency
-  name: roo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.7.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.7.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -654,7 +598,7 @@ files:
 - data/geometry/DOERefWarehouse.json
 - data/geometry/DOERefWarehouse.osm
 - data/inventory/thermal_bridging.csv
-- data/standards/OpenStudio_Standards-deer.xlsx
+- data/standards/OpenStudio_Standards-ashrae_90_1.xlsx
 - data/standards/exclude_list.csv
 - data/standards/export_OpenStudio_libraries.rb
 - data/standards/manage_OpenStudio_Standards.rb
@@ -1047,11 +991,9 @@ files:
 - lib/openstudio-standards/prototypes/common/objects/Prototype.Model.exterior_lights.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.Model.hvac.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.Model.rb
-- lib/openstudio-standards/prototypes/common/objects/Prototype.Model.swh.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.Model.transformers.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.Pump.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.PumpVariableSpeed.rb
-- lib/openstudio-standards/prototypes/common/objects/Prototype.ServiceWaterHeating.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.SizingSystem.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.hvac_systems.rb
 - lib/openstudio-standards/prototypes/common/objects/Prototype.radiant_system_controls.rb
@@ -1075,7 +1017,10 @@ files:
 - lib/openstudio-standards/schedules/information.rb
 - lib/openstudio-standards/schedules/modify.rb
 - lib/openstudio-standards/schedules/parametric.rb
-- lib/openstudio-standards/service_water_heating/component.rb
+- lib/openstudio-standards/service_water_heating/create_piping_losses.rb
+- lib/openstudio-standards/service_water_heating/create_water_heater.rb
+- lib/openstudio-standards/service_water_heating/create_water_heating_loop.rb
+- lib/openstudio-standards/service_water_heating/create_water_use.rb
 - lib/openstudio-standards/space/space.rb
 - lib/openstudio-standards/sql_file/energy_use.rb
 - lib/openstudio-standards/sql_file/fenestration.rb
@@ -1116,6 +1061,7 @@ files:
 - lib/openstudio-standards/standards/Standards.PumpConstantSpeed.rb
 - lib/openstudio-standards/standards/Standards.PumpVariableSpeed.rb
 - lib/openstudio-standards/standards/Standards.ScheduleRuleset.rb
+- lib/openstudio-standards/standards/Standards.ServiceWaterHeating.rb
 - lib/openstudio-standards/standards/Standards.Space.rb
 - lib/openstudio-standards/standards/Standards.SpaceType.rb
 - lib/openstudio-standards/standards/Standards.SubSurface.rb
@@ -2330,6 +2276,7 @@ files:
 - lib/openstudio-standards/standards/necb/NECB2011/autozone.rb
 - lib/openstudio-standards/standards/necb/NECB2011/beps_compliance_path.rb
 - lib/openstudio-standards/standards/necb/NECB2011/building_envelope.rb
+- lib/openstudio-standards/standards/necb/NECB2011/data/boiler_fuel_type_sets.json
 - lib/openstudio-standards/standards/necb/NECB2011/data/boilers.json
 - lib/openstudio-standards/standards/necb/NECB2011/data/chiller_types.json
 - lib/openstudio-standards/standards/necb/NECB2011/data/chillers.json
@@ -2457,6 +2404,7 @@ files:
 - lib/openstudio-standards/standards/necb/common/necb_reference_runs.csv
 - lib/openstudio-standards/standards/necb/common/phius.md
 - lib/openstudio-standards/standards/necb/common/space_type_upgrade_map.json
+- lib/openstudio-standards/standards/necb/docs/air_system_names_method.md
 - lib/openstudio-standards/standards/oeesc/oeesc.rb
 - lib/openstudio-standards/standards/oeesc/oeesc_2014/oeesc_2014.rb
 - lib/openstudio-standards/standards/standard.rb
@@ -2483,7 +2431,8 @@ files:
 homepage: http://openstudio.net
 licenses:
 - Modified BSD License
-metadata: {}
+metadata:
+  documentation_uri: https://gemdocs.org/gems/openstudio-standards
 post_install_message:
 rdoc_options: []
 require_paths: