honeybee-openstudio 2.23.0 → 2.23.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b1713bd43ce02933e6b62917cfd588f51b34474ab42cc964fac0707892ef6cb
-  data.tar.gz: 1b63c7e6ef5ef775b1c6312170fc11cb2117685141e6e6c00d39bc14a4dcb7e9
+  metadata.gz: b883c23eb45c35c5ff82b420a7eba79e2cf2f4c228603531c8f049bf19ca4478
+  data.tar.gz: f2776a7b81b4cb648ecc5171fd50f79face62d79574c0651801a5bad0fd388d9
 SHA512:
-  metadata.gz: b2ce15cb4c8761569e16fae90f1a378a34d4a662abe027458714ed2c11004e84d833dec91ab7795d14d019ada20803a96969ac08c9eb0e8b8f9f725d60911fd5
-  data.tar.gz: 2ed1a4870310d697989c9af03079522af38459cba61280b2053e8b2e59cade74318e5ec43380ca85512ec74258d02b2f13305206c2a3a24e97395de428a95266
+  metadata.gz: 005e5223dd3db47c4a86760d54ed366ed6d2e2a23c31eddb00bab5398744e95de129cac8068708f976393763228953c9ab1e9f2d01949229ca1ed980b98edb67
+  data.tar.gz: 050271b5e95a661bcc489303f9362040a283e891410a1cb4cd71eb3af5f793a69122cbb147cf5fada554240a0a64c88f37a0b53a06188d350406ee319d3488ae

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.23.0'
+  spec.version       = '2.23.4'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 

data/lib/from_openstudio/model.rb

@@ -128,14 +128,10 @@ module Honeybee
     def self.energy_properties_from_model(openstudio_model)
       hash = {}
       hash[:type] = 'ModelEnergyProperties'
-      hash[:constructions] = []
       hash[:constructions] = constructions_from_model(openstudio_model)
       hash[:materials] = materials_from_model(openstudio_model)
-      hash[:construction_sets] = []
       hash[:construction_sets] = constructionsets_from_model(openstudio_model)
-      hash[:schedule_type_limits] = []
       hash[:schedule_type_limits] = schedtypelimits_from_model(openstudio_model)
-      hash[:schedules] = []
       hash[:schedules] = scheduleruleset_from_model(openstudio_model)
 
       hash

data/lib/from_openstudio/schedule/ruleset.rb

@@ -39,23 +39,49 @@ module Honeybee
       # create an empty hash
       hash = {}
       hash[:type] = 'ScheduleRulesetAbridged'
-      # set hash values from OpenStudio Object
-      hash[:identifier] = schedule_ruleset.nameString
-      # check if boost optional object is empty
-      hash[:default_day_schedule] = schedule_ruleset.defaultDaySchedule.nameString 
-      hash[:summer_designday_schedule] = schedule_ruleset.summerDesignDaySchedule.nameString
-      hash[:winter_designday_schedule] = schedule_ruleset.winterDesignDaySchedule.nameString
-      hash[:holiday_schedule] = schedule_ruleset.holidaySchedule.nameString
+      # set the primary (required) day schedules of the object
+      hash[:identifier] = clean_name(schedule_ruleset.nameString)
+      hash[:default_day_schedule] = clean_name(schedule_ruleset.defaultDaySchedule.nameString)
+      hash[:summer_designday_schedule] = clean_name(schedule_ruleset.summerDesignDaySchedule.nameString)
+      hash[:winter_designday_schedule] = clean_name(schedule_ruleset.winterDesignDaySchedule.nameString)
+      hash[:holiday_schedule] = clean_name(schedule_ruleset.holidaySchedule.nameString)
 
-      schedule_days = [schedule_ruleset.defaultDaySchedule, schedule_ruleset.summerDesignDaySchedule, schedule_ruleset.winterDesignDaySchedule, schedule_ruleset.holidaySchedule]
-      hash[:day_schedules] = []
-      schedule_days.each do |schedule_day|
-        hash[:day_schedules] << ScheduleRulesetAbridged.from_day_schedule(schedule_day)
+      # create a list of all day schedules referenced in the Ruleset
+      schedule_days, day_ids = [], []
+      required_days = [
+        schedule_ruleset.defaultDaySchedule,
+        schedule_ruleset.summerDesignDaySchedule,
+        schedule_ruleset.winterDesignDaySchedule,
+        schedule_ruleset.holidaySchedule
+      ]
+      required_days.each do |day_sch|
+        unless day_ids.include? day_sch.nameString
+          schedule_days << day_sch
+          day_ids << day_sch.nameString
+        end
       end
 
+      # loop through the rules and add them along with their day schedules
       hash[:schedule_rules] = []
       schedule_ruleset.scheduleRules.each do |schedule_rule|
         hash[:schedule_rules] << ScheduleRulesetAbridged.from_schedule_rule(schedule_rule)
+        day_sch = schedule_rule.daySchedule
+        unless day_ids.include? day_sch.nameString
+          schedule_days << day_sch
+          day_ids << day_sch.nameString
+        end
+      end
+
+      # write all of the day schedule specifications into the hash
+      hash[:day_schedules] = []
+      schedule_days.each do |schedule_day|
+        hash[:day_schedules] << ScheduleRulesetAbridged.from_day_schedule(schedule_day)
+      end
+
+      # assing any schedule type limits if they exist
+      unless schedule_ruleset.scheduleTypeLimits.empty?
+        typ_lim = schedule_ruleset.scheduleTypeLimits.get
+        hash[:schedule_type_limit] = clean_name(typ_lim.nameString)
       end
 
       hash
@@ -64,7 +90,7 @@ module Honeybee
     def self.from_day_schedule(day_schedule)
       hash = {}
       hash[:type] = 'ScheduleDay'
-      hash[:identifier] = day_schedule.nameString
+      hash[:identifier] = clean_name(day_schedule.nameString)
       hash[:interpolate] = day_schedule.interpolatetoTimestep
       hash[:values] = day_schedule.values
       time_until = [[0,0]]
@@ -80,7 +106,7 @@ module Honeybee
     def self.from_schedule_rule(schedule_rule)
       hash = {}
       hash[:type] = 'ScheduleRuleAbridged'
-      hash[:schedule_day] = schedule_rule.daySchedule.nameString
+      hash[:schedule_day] = clean_name(schedule_rule.daySchedule.nameString)
       hash[:apply_sunday] = schedule_rule.applySunday
       hash[:apply_monday] = schedule_rule.applyMonday
       hash[:apply_tuesday] = schedule_rule.applyTuesday

data/lib/from_openstudio/schedule/type_limit.rb

@@ -40,7 +40,7 @@ module Honeybee
       hash = {}
       hash[:type] = 'ScheduleTypeLimit'
       # set hash values from OpenStudio Object
-      hash[:identifier] = schedule_type_limit.nameString
+      hash[:identifier] = clean_name(schedule_type_limit.nameString)
       # check if boost optional object is empty
       unless schedule_type_limit.lowerLimitValue.empty?
         hash[:lower_limit] = schedule_type_limit.lowerLimitValue.get
@@ -54,7 +54,21 @@ module Honeybee
         numeric_type = schedule_type_limit.numericType.get
         hash[:numeric_type] = numeric_type.titleize
       end
-      hash[:unit_type] = schedule_type_limit.unitType
+
+      # make sure unit type always follows the capitalization of the Honeybee Enumeration
+      unit_type = schedule_type_limit.unitType.titleize
+      if unit_type == 'Deltatemperature'
+        unit_type = 'DeltaTemperature'
+      elsif unit_type == 'Precipitationrate'
+        unit_type = 'PrecipitationRate'
+      elsif unit_type == 'Convectioncoefficient'
+        unit_type = 'ConvectionCoefficient'
+      elsif unit_type == 'Activitylevel'
+        unit_type = 'ActivityLevel'
+      elsif unit_type == 'Controlmode'
+        unit_type = 'Control'
+      end
+      hash[:unit_type] = unit_type
 
       hash
     end

data/lib/honeybee/model_object.rb

@@ -36,13 +36,6 @@ module Honeybee
 
     attr_reader :errors, :warnings
 
-    @@encoding_options = {
-      :invalid           => :replace,  # Replace invalid byte sequences
-      :undef             => :replace,  # Replace anything not defined in ASCII
-      :replace           => '',        # Use a blank for those replacements
-      :universal_newline => true       # Always break lines with \n
-    }
-
     def method_missing(sym, *args)
       name = sym.to_s
       aname = name.sub('=', '')
@@ -107,12 +100,12 @@ module Honeybee
 
     # remove illegal characters in identifier
     def self.clean_name(str)
-      ascii = str.encode(Encoding.find('ASCII'), @@encoding_options)
+      ascii = str.encode(Encoding.find('ASCII'))
     end
 
     # remove illegal characters in identifier
     def self.clean_identifier(str)
-      encode_str = str.encode(Encoding.find('ASCII'), @@encoding_options)
+      encode_str = str.encode(Encoding.find('ASCII'))
       encode_str.gsub(/[^.A-Za-z0-9_-]/, '_').gsub(' ', '_')
     end
 

data/lib/to_openstudio/construction/dynamic.rb

@@ -88,7 +88,7 @@ module Honeybee
 
       # set up the EMS sensor for the schedule value
       state_sch = openstudio_model.getScheduleByName(@hash[:schedule])
-      @sch_sensor_name = replace_ems_special_characters(@hash[:identifier]) + '_Sensor' + @@sensor_count.to_s
+      @sch_sensor_name = replace_ems_special_characters(@hash[:identifier]) + 'Sensor' + @@sensor_count.to_s
       @@sensor_count = @@sensor_count + 1
       unless state_sch.empty?  # schedule not specified
         sch_var = OpenStudio::Model::OutputVariable.new('Schedule Value', openstudio_model)
@@ -107,18 +107,15 @@ module Honeybee
       @sub_faces.each do |dyn_window|
         window_act = OpenStudio::Model::EnergyManagementSystemActuator.new(
           dyn_window, 'Surface', 'Construction State')
-        dyn_window_name = dyn_window.name
-        unless dyn_window_name.empty?
-          act_name = replace_ems_special_characters(dyn_window_name.get) + '_Actuator' + @@actuator_count.to_s
-          @@actuator_count = @@actuator_count + 1
-          window_act.setName(act_name)
-          actuator_names << act_name
-        end
+        act_name = replace_ems_special_characters(dyn_window.nameString) + 'Actuator' + @@actuator_count.to_s
+        @@actuator_count = @@actuator_count + 1
+        window_act.setName(act_name)
+        actuator_names << act_name
       end
 
       # create the EMS Program to accout for each state according to the control logic
       ems_program = OpenStudio::Model::EnergyManagementSystemProgram.new(openstudio_model)
-      prog_name = replace_ems_special_characters(@hash[:identifier]) + '_StateChange' + @@program_count.to_s
+      prog_name = replace_ems_special_characters(@hash[:identifier]) + 'StateChange' + @@program_count.to_s
       @@program_count = @@program_count + 1
       ems_program.setName(prog_name)
 
@@ -143,12 +140,9 @@ module Honeybee
         # create the construction index variable
         constr_i = OpenStudio::Model::EnergyManagementSystemConstructionIndexVariable.new(
           openstudio_model, construction)
-        constr_name = construction.name
-        unless constr_name.empty?
-          constr_i_name = replace_ems_special_characters(constr_name.get) + '_State' + @@state_count.to_s
-          @@state_count = @@state_count + 1
-          constr_i.setName(constr_i_name)
-        end
+        constr_i_name = replace_ems_special_characters(construction.nameString) + 'State' + @@state_count.to_s
+        @@state_count = @@state_count + 1
+        constr_i.setName(constr_i_name)
 
         # loop through the actuators and set the appropriate window state
         actuator_names.each do |act_name|

data/lib/to_openstudio/construction/windowshade.rb

@@ -86,13 +86,13 @@ module Honeybee
       shd_mat_name = openstudio_model.getMaterialByName(@hash[:shade_material])
       unless shd_mat_name.empty?
         @shade_material = shd_mat_name.get
-        obj_type = @shade_material.iddObject.name
+        obj_type = @shade_material.iddObject.name.to_s
       end
       unless @shade_material.nil?
-        if obj_type == 'OS:WindowMaterial:StandardGlazing'
+        if obj_type == 'OS:WindowMaterial:StandardGlazing' || obj_type == 'OS:WindowMaterial:Glazing'
           if @shade_location == 'Interior'
               os_materials[-1] = @shade_material
-          elsif @shade_location == 'Exterior' | os_materials.length < 2
+          elsif @shade_location == 'Exterior' || os_materials.length < 2
               os_materials[0] = @shade_material
           else  # middle glass pane
               os_materials[-3] = @shade_material
@@ -150,9 +150,9 @@ module Honeybee
 
       # figure out the shading type
       unless @shade_material.nil?
-        obj_type = @shade_material.iddObject.name
+        obj_type = @shade_material.iddObject.name.to_s
       end
-      if obj_type == 'OS:WindowMaterial:StandardGlazing'
+      if obj_type == 'OS:WindowMaterial:StandardGlazing' || obj_type == 'OS:WindowMaterial:Glazing'
         shd_type = 'SwitchableGlazing'
       elsif obj_type == 'OS:WindowMaterial:Blind'
         if @shade_location == 'Between'

data/lib/to_openstudio/ventcool/control.rb

@@ -85,7 +85,7 @@ module Honeybee
         in_var.setKeyValue(os_zone_name)
       end
       in_air_temp = OpenStudio::Model::EnergyManagementSystemSensor.new(openstudio_model, in_var)
-      in_sensor_name = replace_ems_special_characters(os_zone_name) + '_Sensor' + @@sensor_count.to_s
+      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)
 
@@ -97,7 +97,7 @@ module Honeybee
           sch_var.setReportingFrequency('Timestep')
           sch_var.setKeyValue(@hash[:schedule])
           sch_sens = OpenStudio::Model::EnergyManagementSystemSensor.new(openstudio_model, sch_var)
-          sch_sensor_name = replace_ems_special_characters(os_zone_name) + '_Sensor' + @@sensor_count.to_s
+          sch_sensor_name = replace_ems_special_characters(os_zone_name) + 'Sensor' + @@sensor_count.to_s
           @@sensor_count = @@sensor_count + 1
           sch_sens.setName(sch_sensor_name)
         end
@@ -108,14 +108,11 @@ module Honeybee
       vent_opening_surfaces.each do |vent_srf|
         window_act = OpenStudio::Model::EnergyManagementSystemActuator.new(
             vent_srf, 'AirFlow Network Window/Door Opening', 'Venting Opening Factor')
-        vent_srf_name = vent_srf.name
-        unless vent_srf_name.empty?
-          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
+        act_name = replace_ems_special_characters(vent_srf.nameString) + \
+          'OpenFactor' + @@actuator_count.to_s
+          @@actuator_count = @@actuator_count + 1
+        window_act.setName(act_name)
+        actuator_names << act_name
       end
 
       # create the first line of the EMS Program to open each window according to the control logic
@@ -158,7 +155,7 @@ module Honeybee
 
       # initialize the program and add the complete logic
       ems_program = OpenStudio::Model::EnergyManagementSystemProgram.new(openstudio_model)
-      prog_name = replace_ems_special_characters(os_zone_name) + '_WindowOpening' + @@program_count.to_s
+      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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.23.0
+  version: 2.23.4
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler