honeybee-openstudio 2.6.0 → 2.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c28727c336caac62e6fe1758d4bdcb3c7440a8f6da5bedf777094d4786926ba7
-  data.tar.gz: 8d111e901b300df779ed35574b98e5c4d82231ba50ba398f1f88fb3b61d2016a
+  metadata.gz: f0cd1e90f3447c7eaac2dd6292a705f79de608789270dcfab5a431027870190f
+  data.tar.gz: 9bd7a9af5dffb44bf6fa16c7f7626d07fc4dcbd2b596298425c16b6b80543568
 SHA512:
-  metadata.gz: 40be5068a614f6c171eca8465381692d5273035688e047cecd4f14a2115d5f8a0f2ee356944383b854bdcf4af9e12955b1dd83831ec2f4a5e7971d49d4ddf8c8
-  data.tar.gz: c7273c379fc78675073e4bbd482b903cbad150624ff908fdb2da96bd7b5961277a1350a5d74c9f0aacd51f029657680377b7e93363fec835903cd3639623a41b
+  metadata.gz: d4ac4d6f8edfa3adcd377db33357250b96bf1bb56bef117b63690c67ed22354ed27edb40560ce79daf0360513d237d7f0a7d6c50d9b754ef0fd361b4fbcc7703
+  data.tar.gz: 0e1067509315f8f2e503e3b78b61a1aaf2b68aedcd8d95c450c011980022a83a349d2bff04ccf5074a760b4673f3494c9df422c9699428b94df1f1c0407bbcc6

data/honeybee-openstudio.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'honeybee-openstudio'
-  spec.version       = '2.6.0'
+  spec.version       = '2.6.5'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 

data/lib/files/urbanopt_Gemfile

@@ -21,4 +21,4 @@ else
 end
 
 # include the honeybee-openstudio-gem
-gem 'honeybee-openstudio', '2.5.3'
+gem 'honeybee-openstudio', '2.6.4'

data/lib/from_honeybee/construction/air.rb

@@ -55,7 +55,12 @@ module FromHoneybee
       os_construction = OpenStudio::Model::ConstructionAirBoundary.new(openstudio_model)
       os_construction.setName(@hash[:identifier])
       os_construction.setSolarAndDaylightingMethod('GroupedZones')
-      os_construction.setRadiantExchangeMethod('GroupedZones')
+      # REMOVE: Remove the use of IRTSurface once the AFN works with GroupedZone air walls
+      if !$use_simple_vent  # we're using the AFN!
+        os_construction.setRadiantExchangeMethod('IRTSurface')
+      else
+        os_construction.setRadiantExchangeMethod('GroupedZones')
+      end
       os_construction.setAirExchangeMethod('None')
 
       os_construction

data/lib/from_honeybee/geometry/room.rb

@@ -140,7 +140,8 @@ module FromHoneybee
         if face[:apertures]
           face[:apertures].each do |aperture|
             if aperture[:properties][:energy][:vent_opening]
-              window_vent[aperture[:identifier]] = aperture[:properties][:energy][:vent_opening]
+              window_vent[aperture[:identifier]] = \
+                [aperture[:properties][:energy][:vent_opening], aperture[:boundary_condition][:type]]
             end
             if aperture[:outdoor_shades]
               unless os_shd_group
@@ -157,7 +158,8 @@ module FromHoneybee
         if face[:doors]
           face[:doors].each do |door|
             if door[:properties][:energy][:vent_opening]
-              window_vent[door[:identifier]] = door[:properties][:energy][:vent_opening]
+              window_vent[door[:identifier]] = \
+                [door[:properties][:energy][:vent_opening], door[:boundary_condition][:type]]
             end
             if door[:outdoor_shades]
               unless os_shd_group
@@ -312,14 +314,18 @@ module FromHoneybee
 
       # assign window ventilation objects if they exist
       if $use_simple_vent && !window_vent.empty?  # write simple WindAndStack ventilation
-        window_vent.each do |sub_f_id, opening|
-          opt_sub_f = openstudio_model.getSubSurfaceByName(sub_f_id)
-          unless opt_sub_f.empty?
-            sub_f = opt_sub_f.get
-            window_vent = VentilationOpening.new(opening)
-            os_window_vent = window_vent.to_openstudio(
-              openstudio_model, sub_f, @hash[:properties][:energy][:window_vent_control])
-            os_window_vent.addToThermalZone(os_thermal_zone)
+        window_vent.each do |sub_f_id, open_prop|
+          opening = open_prop[0]
+          bc = open_prop[1]
+          if bc == 'Outdoors'
+            opt_sub_f = openstudio_model.getSubSurfaceByName(sub_f_id)
+            unless opt_sub_f.empty?
+              sub_f = opt_sub_f.get
+              vent_open = VentilationOpening.new(opening)
+              os_vent_open = vent_open.to_openstudio(
+                openstudio_model, sub_f, @hash[:properties][:energy][:window_vent_control])
+              os_vent_open.addToThermalZone(os_thermal_zone)
+            end
           end
         end
       elsif !$use_simple_vent  # we're using the AFN!
@@ -329,13 +335,14 @@ module FromHoneybee
         # write the opening objects for each Aperture / Door
         operable_subfs = []  # collect the sub-face objects for the EMS
         opening_factors = []  # collect the maximum opening factors for the EMS
-        window_vent.each do |sub_f_id, opening|
+        window_vent.each do |sub_f_id, open_prop|
+          opening = open_prop[0]
           opt_sub_f = openstudio_model.getSubSurfaceByName(sub_f_id)
           unless opt_sub_f.empty?
             sub_f = opt_sub_f.get
             if sub_f.adjacentSubSurface.empty?  # not an interior window that's already in the AFN
-              window_vent = VentilationOpening.new(opening)
-              open_fac = window_vent.to_openstudio_afn(openstudio_model, sub_f)
+              vent_open = VentilationOpening.new(opening)
+              open_fac = vent_open.to_openstudio_afn(openstudio_model, sub_f)
               operable_subfs << sub_f
               opening_factors << open_fac
             end

data/lib/from_honeybee/model.rb

@@ -533,12 +533,14 @@ module FromHoneybee
           system_type = hvac[:type]
           if system_type == 'IdealAirSystemAbridged'
             ideal_air_system = IdealAirSystemAbridged.new(hvac)
-            os_ideal_air_system = ideal_air_system.to_openstudio(@openstudio_model)
             hvac['rooms'].each do |room_id|
+              os_ideal_air = ideal_air_system.to_openstudio(@openstudio_model)
+              # enforce a strict naming system for each zone so results can be matched
+              os_ideal_air.setName(room_id + ' Ideal Loads Air System')
               zone_get = @openstudio_model.getThermalZoneByName(room_id)
               unless zone_get.empty?
                 os_thermal_zone = zone_get.get
-                os_ideal_air_system.addToThermalZone(os_thermal_zone)
+                os_ideal_air.addToThermalZone(os_thermal_zone)
               end
             end
           elsif TemplateHVAC.types.include?(system_type)

data/lib/from_honeybee/schedule/ruleset.rb

@@ -138,7 +138,7 @@ module FromHoneybee
           openstudio_schedule_rule.setApplyFriday(rule[:apply_friday])
           openstudio_schedule_rule.setApplySaturday(rule[:apply_saturday])
           year_description = openstudio_model.getYearDescription
-          start_date = year_description.makeDate(rule[:start_date][0], rule[:start_date][1])         
+          start_date = year_description.makeDate(rule[:start_date][0], rule[:start_date][1])
           end_date = year_description.makeDate(rule[:end_date][0], rule[:end_date][1])
           openstudio_schedule_rule.setStartDate(start_date)
           openstudio_schedule_rule.setEndDate(end_date)

data/lib/from_honeybee/simulation/parameter.rb

@@ -288,7 +288,18 @@ module FromHoneybee
             @hash[:run_period][:daylight_saving_time][:end_date][1])
         end
 
-        # TODO: set the holidays once they are available in OpenStudio SDK
+        # Set the holidays
+        if @hash[:run_period][:holidays]
+          @hash[:run_period][:holidays].each do |hol|
+            begin
+              os_hol = OpenStudio::Model::RunPeriodControlSpecialDays.new(
+                OpenStudio::MonthOfYear.new(hol[0]), hol[1], @openstudio_model)
+              os_hol.setDuration(1)
+              os_hol.setSpecialDayType('Holiday')
+            rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+            end
+          end
+        end
       end
 
       # set the simulation timestep

data/lib/from_honeybee/ventcool/control.rb

@@ -38,6 +38,9 @@ module FromHoneybee
     attr_reader :errors, :warnings
     @@outdoor_node = nil
     @@program_manager = nil
+    @@sensor_count = 1
+    @@actuator_count = 1
+    @@program_count = 1
 
     def initialize(hash = {})
       super(hash)
@@ -72,6 +75,13 @@ module FromHoneybee
       @@program_manager
       end
 
+    def replace_ems_special_characters(ems_variable_name)
+      # remove special characters from an name to be used as an EMS variable
+      new_name = ems_variable_name.to_s
+      new_name.gsub!(/[^A-Za-z]/, '')
+      new_name
+    end
+
     def to_openstudio(openstudio_model, parent_zone, vent_opening_surfaces, vent_opening_factors)
       # Get the outdoor temperature sensor and the room air temperature sensor
       out_air_temp = get_outdoor_node(openstudio_model)
@@ -84,7 +94,8 @@ module FromHoneybee
         in_var.setKeyValue(os_zone_name)
       end
       in_air_temp = OpenStudio::Model::EnergyManagementSystemSensor.new(openstudio_model, in_var)
-      in_sensor_name = os_zone_name.delete(' ').delete('.') + '_Sensor'
+      in_sensor_name = replace_ems_special_characters(os_zone_name) + '_Sensor' + @@sensor_count.to_s
+      @@sensor_count = @@sensor_count + 1
       in_air_temp.setName(in_sensor_name)
 
       # create the actuators for each of the operaable windows
@@ -94,7 +105,9 @@ module FromHoneybee
             vent_srf, 'AirFlow Network Window/Door Opening', 'Venting Opening Factor')
         vent_srf_name = vent_srf.name
         unless vent_srf_name.empty?
-          act_name = vent_srf_name.get.delete(' ').delete('.') + '_OpenFactor'
+          act_name = replace_ems_special_characters(vent_srf_name.get) + \
+            '_OpenFactor' + @@actuator_count.to_s
+            @@actuator_count = @@actuator_count + 1
           window_act.setName(act_name)
           actuator_names << act_name
         end
@@ -136,7 +149,9 @@ module FromHoneybee
 
       # initialize the program and add the complete logic
       ems_program = OpenStudio::Model::EnergyManagementSystemProgram.new(openstudio_model)
-      ems_program.setName(os_zone_name.delete(' ').delete('.') + '_WindowOpening')
+      prog_name = replace_ems_special_characters(os_zone_name) + '_WindowOpening' + @@program_count.to_s
+      @@program_count = @@program_count + 1
+      ems_program.setName(prog_name)
       ems_program.addLine(complete_logic)
 
       # loop through each of the actuators and open each window

data/lib/from_honeybee/ventcool/opening.rb

@@ -150,7 +150,7 @@ module FromHoneybee
 
       # create the simple opening object for the Aperture or Door using default values
       flow_exponent = defaults[:flow_exponent_closed][:default].to_f
-      two_way_thresh= defaults[:two_way_threshold][:default].to_f
+      two_way_thresh = defaults[:two_way_threshold][:default].to_f
       discharge_coeff = defaults[:discharge_coefficient][:default].to_f
       os_opening = OpenStudio::Model::AirflowNetworkSimpleOpening.new(
         openstudio_model, flow_coefficient, flow_exponent, two_way_thresh, discharge_coeff)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.5
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler