honeybee-openstudio 2.22.3 → 2.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b23a8787eb73cfedcfb87593efb1089039ddf316fef2c45ef5911251a2a7b7fe
-  data.tar.gz: '019c3ea7029d7372de457911e7fbb08f690f83fc27e5605249e273b9bb677701'
+  metadata.gz: f5b611d0b78befb14bd1968ad3bc09479295c7367265049523c28ef3b3e3feeb
+  data.tar.gz: 6630478417dcc8d8680339b3d673b857ac6e0593152310213a3dc9c6eb227914
 SHA512:
-  metadata.gz: 3ebc33a0448cfc47bf86dc954d7186798d35482975b5a3fd66efcfe7003e7c1e06b43334621935e5eda599e433c68b3e64d7b9414bc80280af8b56ad503b55b4
-  data.tar.gz: 9923b7fec07cc6729d8a7f882802022629073671e2e2d9c53e5afb244ddbb9e87a8fd3a93e32a748742ba1cc079b32dc1e5d4a36b598d68b36deefc6574bf7ac
+  metadata.gz: 549cb01585b8b2983b5d5014703325bf87a83db1cc600c4f4ed557a501d998cc5e2632970a7d58d0c75d7a34234a11befbe2eb27c49c085303d25708040c794a
+  data.tar.gz: 16c6ed67bb2a2a8a5e83fe63641dee6db8df13a855103149565a4d476e0746c02a7837d12307f45ad67fe77854d2c572fcd39323434be5338395e27bb98f36a5

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

data/lib/from_openstudio/construction/air.rb

@@ -40,11 +40,11 @@ module Honeybee
         hash = {}
         hash[:type] = 'AirBoundaryConstructionAbridged'
         # set hash values from OpenStudio Object
-        hash[:identifier] = construction.nameString
+        hash[:identifier] = clean_name(construction.nameString)
         # check if boost optional object is empty
         unless construction.simpleMixingSchedule.empty?
           schedule = construction.simpleMixingSchedule.get
-          hash[:air_mixing_schedule] = schedule.nameString
+          hash[:air_mixing_schedule] = clean_name(schedule.nameString)
         end
         #TODO: Add air_mixing_per_area
 

data/lib/from_openstudio/construction/opaque.rb

@@ -40,12 +40,12 @@ module Honeybee
         hash = {}
         hash[:type] = 'OpaqueConstructionAbridged'
         # set hash values from OpenStudio Object
-        hash[:identifier] = construction.nameString
+        hash[:identifier] = clean_name(construction.nameString)
         hash[:materials] = []
         # get construction layers
         layers = construction.layers
         layers.each do |layer|
-          name = layer.nameString
+          name = clean_name(layer.nameString)
           hash[:materials] << name
         end
 

data/lib/from_openstudio/construction/shade.rb

@@ -40,7 +40,7 @@ module Honeybee
         hash = {}
         hash[:type] = 'ShadeConstruction'
         # set hash values from OpenStudio Object
-        hash[:identifier] = construction.nameString
+        hash[:identifier] = clean_name(construction.nameString)
         # get outermost construction layers
         layer = construction.layers[0]
         if layer.to_StandardGlazing.is_initialized
@@ -61,7 +61,7 @@ module Honeybee
             hash[:solar_reflectance] = layer.solarReflectance.get
           end
           unless layer.visibleReflectance.empty?
-            hash[:visible_reflectance] = layer.visibleReflectance
+            hash[:visible_reflectance] = layer.visibleReflectance.get
           end
         elsif layer.to_MasslessOpaqueMaterial.is_initialized
           layer = layer.to_MasslessOpaqueMaterial.get

data/lib/from_openstudio/construction/window.rb

@@ -40,12 +40,12 @@ module Honeybee
         hash = {}
         hash[:type] = 'WindowConstructionAbridged'
         # set hash values from OpenStudio Object
-        hash[:identifier] = construction.nameString
+        hash[:identifier] = clean_name(construction.nameString)
         hash[:materials] = []
         # get construction layers
         layers = construction.layers
         layers.each do |layer|
-          name = layer.nameString
+          name = clean_name(layer.nameString)
           hash[:materials] << name
         end
 

data/lib/from_openstudio/construction_set.rb

@@ -40,7 +40,7 @@ module Honeybee
         hash = {}
         hash[:type] = 'ConstructionSetAbridged'
         # set hash values from OpenStudio Object
-        hash[:identifier] = construction_set.nameString
+        hash[:identifier] = clean_name(construction_set.nameString)
         hash[:wall_set] = {}
         hash[:floor_set] = {}
         hash[:aperture_set] = {}
@@ -53,17 +53,17 @@ module Honeybee
           # get interior wall construction
           unless int_surf_construction.wallConstruction.empty?
             int_wall_const = int_surf_construction.wallConstruction.get
-            hash[:wall_set][:interior_construction] = int_wall_const.nameString
+            hash[:wall_set][:interior_construction] = clean_name(int_wall_const.nameString)
           end
           # get interior floor construction
           unless int_surf_construction.floorConstruction.empty?
             int_floor_const = int_surf_construction.floorConstruction.get
-            hash[:floor_set][:interior_construction] = int_floor_const.nameString
+            hash[:floor_set][:interior_construction] = clean_name(int_floor_const.nameString)
           end
           # get interior roofceiling construction
           unless int_surf_construction.roofCeilingConstruction.empty?
             int_roof_const = int_surf_construction.roofCeilingConstruction.get
-            hash[:roof_ceiling_set][:interior_construction] = int_roof_const.nameString
+            hash[:roof_ceiling_set][:interior_construction] = clean_name(int_roof_const.nameString)
           end
         end
 
@@ -72,17 +72,17 @@ module Honeybee
           int_subsurf_const = construction_set.defaultInteriorSubSurfaceConstructions.get
           unless int_subsurf_const.fixedWindowConstruction.empty?
             int_wind_const = int_subsurf_const.fixedWindowConstruction.get
-            hash[:aperture_set][:window_construction] = int_wind_const.nameString
+            hash[:aperture_set][:window_construction] = clean_name(int_wind_const.nameString)
           end
           # get interior door construction
           unless int_subsurf_const.doorConstruction.empty?
             int_door_const = int_subsurf_const.doorConstruction.get
-            hash[:door_set][:interior_construction] = int_door_const.nameString
+            hash[:door_set][:interior_construction] = clean_name(int_door_const.nameString)
           end
           # get interior glass door construction
           unless int_subsurf_const.glassDoorConstruction.empty?
             int_glass_door_const = int_subsurf_const.glassDoorConstruction.get
-            hash[:door_set][:interior_glass_construction] = int_glass_door_const.nameString
+            hash[:door_set][:interior_glass_construction] = clean_name(int_glass_door_const.nameString)
           end
         end
         
@@ -92,17 +92,17 @@ module Honeybee
           # get exterior wall construction
           unless ext_surf_const.wallConstruction.empty?
             ext_wall_const = ext_surf_const.wallConstruction.get
-            hash[:wall_set][:exterior_construction] = ext_wall_const.nameString
+            hash[:wall_set][:exterior_construction] = clean_name(ext_wall_const.nameString)
           end
           # get exterior floor construction
           unless ext_surf_const.floorConstruction.empty?
             ext_floor_const = ext_surf_const.floorConstruction.get
-            hash[:floor_set][:exterior_construction] = ext_floor_const.nameString
+            hash[:floor_set][:exterior_construction] = clean_name(ext_floor_const.nameString)
           end
           # get exterior roofceiling construction
           unless ext_surf_const.roofCeilingConstruction.empty?
             ext_roof_const = ext_surf_const.roofCeilingConstruction.get
-            hash[:roof_ceiling_set][:exterior_construction] = ext_roof_const.nameString
+            hash[:roof_ceiling_set][:exterior_construction] = clean_name(ext_roof_const.nameString)
           end
         end
 
@@ -112,22 +112,22 @@ module Honeybee
           # get exterior operable window construction
           unless ext_subsurf_const.operableWindowConstruction.empty?
             ext_wind_const = ext_subsurf_const.operableWindowConstruction.get
-            hash[:aperture_set][:operable_construction] = ext_wind_const.nameString
+            hash[:aperture_set][:operable_construction] = clean_name(ext_wind_const.nameString)
           end
           # get exterior skylight construction
           unless ext_subsurf_const.skylightConstruction.empty?
             ext_skylight_const = ext_subsurf_const.skylightConstruction.get
-            hash[:aperture_set][:skylight_construction] = ext_skylight_const.nameString
+            hash[:aperture_set][:skylight_construction] = clean_name(ext_skylight_const.nameString)
           end
           # get exterior door construction
           unless ext_subsurf_const.doorConstruction.empty?
             ext_door_const = ext_subsurf_const.doorConstruction.get
-            hash[:door_set][:exterior_construction] = ext_door_const.nameString
+            hash[:door_set][:exterior_construction] = clean_name(ext_door_const.nameString)
           end
           # get exterior overhead door construction
           unless ext_subsurf_const.overheadDoorConstruction.empty?
             ext_ovhd_door_const = ext_subsurf_const.overheadDoorConstruction.get
-            hash[:door_set][:overhead_construction] = ext_ovhd_door_const.nameString
+            hash[:door_set][:overhead_construction] = clean_name(ext_ovhd_door_const.nameString)
           end
         end
 

data/lib/from_openstudio/geometry/aperture.rb

@@ -40,7 +40,7 @@ module Honeybee
       hash = {}
       hash[:type] = 'Aperture'
       hash[:identifier] = clean_identifier(sub_surface.nameString)
-      hash[:display_name] = clean_display_name(sub_surface.nameString)
+      hash[:display_name] = clean_name(sub_surface.nameString)
       hash[:user_data] = {handle: sub_surface.handle.to_s}
       hash[:properties] = properties_from_sub_surface(sub_surface)
       hash[:geometry] = geometry_from_sub_surface(sub_surface, site_transformation)

data/lib/from_openstudio/geometry/door.rb

@@ -40,7 +40,7 @@ module Honeybee
       hash = {}
       hash[:type] = 'Door'
       hash[:identifier] = clean_identifier(sub_surface.nameString)
-      hash[:display_name] = clean_display_name(sub_surface.nameString)
+      hash[:display_name] = clean_name(sub_surface.nameString)
       hash[:user_data] = {handle: sub_surface.handle.to_s}
       hash[:properties] = properties_from_sub_surface(sub_surface)
       hash[:geometry] = geometry_from_sub_surface(sub_surface, site_transformation)

data/lib/from_openstudio/geometry/face.rb

@@ -38,7 +38,7 @@ module Honeybee
       hash = {}
       hash[:type] = 'Face'
       hash[:identifier] = clean_identifier(surface.nameString)
-      hash[:display_name] = clean_display_name(surface.nameString)
+      hash[:display_name] = clean_name(surface.nameString)
       hash[:user_data] = {handle: surface.handle.to_s}
       hash[:properties] = properties_from_surface(surface)
       hash[:geometry] = geometry_from_surface(surface, site_transformation)

data/lib/from_openstudio/geometry/room.rb

@@ -38,7 +38,7 @@ module Honeybee
       hash = {}
       hash[:type] = 'Room'
       hash[:identifier] = clean_identifier(space.nameString)
-      hash[:display_name] = clean_display_name(space.nameString)
+      hash[:display_name] = clean_name(space.nameString)
       hash[:user_data] = {space: space.handle.to_s}
       hash[:properties] = properties_from_space(space)
 

data/lib/from_openstudio/geometry/shade.rb

@@ -40,7 +40,7 @@ module Honeybee
       hash = {}
       hash[:type] = 'Shade'
       hash[:identifier] = clean_identifier(shading_surface.nameString)
-      hash[:display_name] = clean_display_name(shading_surface.nameString)
+      hash[:display_name] = clean_name(shading_surface.nameString)
       hash[:user_data] = {handle: shading_surface.handle.to_s}
       hash[:properties] = properties_from_shading_surface(shading_surface)
       hash[:geometry] = geometry_from_shading_surface(shading_surface, site_transformation)

data/lib/from_openstudio/material/opaque.rb

@@ -40,7 +40,7 @@ module Honeybee
         hash = {}
         hash[:type] = 'EnergyMaterial'
         # set hash values from OpenStudio Object
-        hash[:identifier] = material.nameString
+        hash[:identifier] = clean_name(material.nameString)
         hash[:thickness] = material.thickness
         hash[:conductivity] = material.conductivity
         hash[:density] = material.density

data/lib/from_openstudio/material/opaque_no_mass.rb

@@ -40,7 +40,7 @@ module Honeybee
         hash = {}
         hash[:type] = 'EnergyMaterialNoMass'
         # set hash values from OpenStudio Object
-        hash[:identifier] = material.nameString
+        hash[:identifier] = clean_name(material.nameString)
         hash[:r_value] = material.thermalResistance
 
         if material.to_MasslessOpaqueMaterial.is_initialized

data/lib/from_openstudio/material/window_blind.rb

@@ -40,7 +40,7 @@ module Honeybee
         hash = {}
         hash[:type] = 'EnergyWindowMaterialBlind'
         # set hash values from OpenStudio Object
-        hash[:identifier] = material.nameString
+        hash[:identifier] = clean_name(material.nameString)
         hash[:slat_orientation] = material.slatOrientation
         hash[:slat_width] = material.slatWidth
         hash[:slat_separation] = material.slatSeparation

data/lib/from_openstudio/material/window_gas.rb

@@ -40,7 +40,7 @@ module Honeybee
         hash = {}
         hash[:type] = 'EnergyWindowMaterialGas'
         # set hash values from OpenStudio Object
-        hash[:identifier] = material.nameString
+        hash[:identifier] = clean_name(material.nameString)
         hash[:thickness] = material.thickness
         hash[:gas_type] = material.gasType
 

data/lib/from_openstudio/material/window_gas_custom.rb

@@ -40,7 +40,7 @@ module Honeybee
         hash = {}
         hash[:type] = 'EnergyWindowMaterialGasCustom'
         # set hash values from OpenStudio Object
-        hash[:identifier] = material.nameString
+        hash[:identifier] = clean_name(material.nameString)
         hash[:thickness] = material.thickness
         # check if boost optional object is empty
         unless material.customConductivityCoefficientA.empty?

data/lib/from_openstudio/material/window_gas_mixture.rb

@@ -40,7 +40,7 @@ module Honeybee
         hash = {}
         hash[:type] = 'EnergyWindowMaterialGasMixture'
         # set hash values from OpenStudio Object
-        hash[:identifier] = material.nameString
+        hash[:identifier] = clean_name(material.nameString)
         hash[:thickness] = material.thickness
         hash[:gas_types] = []
         hash[:gas_fractions] = []

data/lib/from_openstudio/material/window_glazing.rb

@@ -40,7 +40,7 @@ module Honeybee
         hash = {}
         hash[:type] = 'EnergyWindowMaterialGlazing'
         # set hash values from OpenStudio Object
-        hash[:identifier] = material.nameString
+        hash[:identifier] = clean_name(material.nameString)
         hash[:thickness] = material.thickness
         hash[:solar_transmittance] = material.solarTransmittance
         # check if boost optional object is empty

data/lib/from_openstudio/material/window_simpleglazsys.rb

@@ -40,7 +40,7 @@ module Honeybee
         hash = {}
         hash[:type] = 'EnergyWindowMaterialSimpleGlazSys'
         # set hash values from OpenStudio Object
-        hash[:identifier] = material.nameString
+        hash[:identifier] = clean_name(material.nameString)
         hash[:u_factor] = material.uFactor
         hash[:shgc] = material.solarHeatGainCoefficient
         # check if boost optional object is empty

data/lib/from_openstudio/model.rb

@@ -46,6 +46,8 @@ require 'from_openstudio/construction/opaque'
 require 'from_openstudio/construction/window'
 require 'from_openstudio/construction/shade'
 require 'from_openstudio/construction_set'
+require 'from_openstudio/schedule/type_limit'
+require 'from_openstudio/schedule/ruleset'
 
 require 'openstudio'
 
@@ -126,11 +128,11 @@ 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] = schedtypelimits_from_model(openstudio_model)
+      hash[:schedules] = scheduleruleset_from_model(openstudio_model)
 
       hash
     end
@@ -266,5 +268,24 @@ module Honeybee
       result
     end
 
+    # Create HB Schedule Type Limits from OpenStudio Schedule Type Limits
+    def self.schedtypelimits_from_model(openstudio_model)
+      result = []
+      openstudio_model.getScheduleTypeLimitss.each do |sch_typ_lim|
+        result << ScheduleTypeLimit.from_schedule_type_limit(sch_typ_lim)
+      end
+
+      result
+    end
+
+    # Create HB Schedule Ruleset from OpenStudio Ruleset
+    def self.scheduleruleset_from_model(openstudio_model)
+      result = []
+      openstudio_model.getScheduleRulesets.each do |sch_ruleset|
+        result << ScheduleRulesetAbridged.from_schedule_ruleset(sch_ruleset)
+      end
+      result
+    end
+
   end # Model
 end # Honeybee

data/lib/from_openstudio/schedule/ruleset.rb

@@ -0,0 +1,140 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. 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.
+#
+# 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.
+# *******************************************************************************
+
+require 'honeybee/schedule/ruleset'
+require 'from_openstudio/model_object'
+
+module Honeybee
+  class ScheduleRulesetAbridged < ModelObject
+
+    def self.from_schedule_ruleset(schedule_ruleset)
+      # create an empty hash
+      hash = {}
+      hash[:type] = 'ScheduleRulesetAbridged'
+      # 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)
+
+      # 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
+    end
+
+    def self.from_day_schedule(day_schedule)
+      hash = {}
+      hash[:type] = 'ScheduleDay'
+      hash[:identifier] = clean_name(day_schedule.nameString)
+      hash[:interpolate] = day_schedule.interpolatetoTimestep
+      hash[:values] = day_schedule.values
+      time_until = [[0,0]]
+      day_schedule.times.each do |time|
+        time_until << [time.hours, time.minutes]
+      end
+      time_until.delete_at(-1)
+      hash[:times] = time_until
+
+      hash
+    end
+
+    def self.from_schedule_rule(schedule_rule)
+      hash = {}
+      hash[:type] = 'ScheduleRuleAbridged'
+      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
+      hash[:apply_wednesday] = schedule_rule.applyWednesday
+      hash[:apply_thursday] = schedule_rule.applyThursday
+      hash[:apply_friday] = schedule_rule.applyFriday
+      hash[:apply_saturday] = schedule_rule.applySaturday
+      
+      #boost optional
+      unless schedule_rule.startDate.empty?
+        start_date = schedule_rule.startDate.get       
+        hash[:start_date] = [(start_date.monthOfYear).value, start_date.dayOfMonth]
+        if start_date.isLeapYear
+          hash[:start_date] << 1
+        end
+      end
+
+      #boost optional
+      unless schedule_rule.endDate.empty?
+        end_date = schedule_rule.endDate.get
+        hash[:end_date] = [(end_date.monthOfYear).value, end_date.dayOfMonth]
+        if start_date.isLeapYear
+          hash[:end_date] << 1
+        end
+      end
+
+      hash
+    end
+
+  end # ScheduleRulesetAbridged
+end # Honeybee

data/lib/from_openstudio/schedule/type_limit.rb

@@ -0,0 +1,75 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. 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.
+#
+# 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.
+# *******************************************************************************
+
+require 'honeybee/schedule/type_limit'
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class ScheduleTypeLimit < ModelObject
+
+    def self.from_schedule_type_limit(schedule_type_limit)
+      # create an empty hash
+      hash = {}
+      hash[:type] = 'ScheduleTypeLimit'
+      # set hash values from OpenStudio Object
+      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
+      end
+      # check if boost optional object is empty
+      unless schedule_type_limit.upperLimitValue.empty?
+        hash[:upper_limit] = schedule_type_limit.upperLimitValue.get
+      end
+      # check if boost optional object is empty
+      unless schedule_type_limit.numericType.empty?
+        numeric_type = schedule_type_limit.numericType.get
+        hash[:numeric_type] = numeric_type.titleize
+      end
+
+      # 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'
+      end
+      hash[:unit_type] = unit_type
+
+      hash
+    end
+
+  end # ScheduleTypeLimit
+end # Honeybee

data/lib/from_openstudio.rb

@@ -63,4 +63,8 @@ require 'from_openstudio/material/window_simpleglazsys'
 # extend the simulation objects
 require 'from_openstudio/simulation/design_day'
 require 'from_openstudio/simulation/parameter_model'
-require 'from_openstudio/simulation/simulation_output'
+require 'from_openstudio/simulation/simulation_output'
+
+# extend the schedule objects
+require 'from_openstudio/schedule/type_limit'
+require 'from_openstudio/schedule/ruleset'

data/lib/honeybee/_defaults/energy_default.json

@@ -54,7 +54,10 @@
             "identifier": "Generic Single Pane",
             "materials": [
                 "Generic Clear Glass"
-            ]
+            ],
+            "u_factor": 5.731373,
+            "shgc": 0.824407,
+            "vt": 0.88
         },
         {
             "type": "ShadeConstruction",
@@ -170,7 +173,10 @@
                 "Generic Low-e Glass",
                 "Generic Window Air Gap",
                 "Generic Clear Glass"
-            ]
+            ],
+            "u_factor": 1.687787,
+            "shgc": 0.43651,
+            "vt": 0.635473
         },
         {
             "type": "OpaqueConstructionAbridged",

data/lib/honeybee/model.rb

@@ -51,6 +51,7 @@ module Honeybee
       @@extension ||= Extension.new
       @@schema ||= @@extension.schema
       @@standards ||= @@extension.standards
+      $simple_window_cons = false
 
       @hash = hash
       @type = @hash[:type]

data/lib/honeybee/model_object.rb

@@ -36,6 +36,13 @@ 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('=', '')
@@ -99,13 +106,14 @@ module Honeybee
     end
 
     # remove illegal characters in identifier
-    def self.clean_display_name(str)
-      str.gsub(/[^[:ascii:]]/, '')
+    def self.clean_name(str)
+      ascii = str.encode(Encoding.find('ASCII'), @@encoding_options)
     end
 
     # remove illegal characters in identifier
     def self.clean_identifier(str)
-      str.gsub(/[^.A-Za-z0-9_-]/, '_').gsub(' ', '_')
+      encode_str = str.encode(Encoding.find('ASCII'), @@encoding_options)
+      encode_str.gsub(/[^.A-Za-z0-9_-]/, '_').gsub(' ', '_')
     end
 
 

data/lib/measures/from_honeybee_model_to_gbxml/measure.rb

@@ -86,6 +86,7 @@ class FromHoneybeeModelToGbxml < OpenStudio::Measure::ModelMeasure
       return false
     end
     honeybee_model = Honeybee::Model.read_from_disk(model_json)
+    $simple_window_cons = true
     STDOUT.flush
     os_model = honeybee_model.to_openstudio_model(model)
     STDOUT.flush

data/lib/to_openstudio/construction/window.rb

@@ -50,16 +50,25 @@ module Honeybee
       # create material vector
       os_materials = OpenStudio::Model::MaterialVector.new
       # loop through each layer and add to material vector
-      if @hash.key?(:layers)
-        mat_key = :layers
+      if $simple_window_cons && @hash[:u_factor]
+        os_simple_glazing = OpenStudio::Model::SimpleGlazing.new(openstudio_model)
+        os_simple_glazing.setName(@hash[:identifier] + '_SimpleGlazSys')
+        os_simple_glazing.setUFactor(@hash[:u_factor])
+        os_simple_glazing.setSolarHeatGainCoefficient(@hash[:shgc])
+        os_simple_glazing.setVisibleTransmittance(@hash[:vt])
+        os_materials << os_simple_glazing
       else
-        mat_key = :materials
-      end
-      @hash[mat_key].each do |material_identifier|
-        material = openstudio_model.getMaterialByName(material_identifier)
-        unless material.empty?
-          os_material = material.get
-          os_materials << os_material
+        if @hash.key?(:layers)
+          mat_key = :layers
+        else
+          mat_key = :materials
+        end
+        @hash[mat_key].each do |material_identifier|
+          material = openstudio_model.getMaterialByName(material_identifier)
+          unless material.empty?
+            os_material = material.get
+            os_materials << os_material
+          end
         end
       end
       os_construction.setLayers(os_materials)

data/lib/to_openstudio/geometry/room.rb

@@ -105,6 +105,14 @@ module Honeybee
         os_thermal_zone.setMultiplier(@hash[:multiplier])
       end
 
+      # assign the geometry properties if they exist
+      if @hash[:ceiling_height]
+        os_thermal_zone.setCeilingHeight(@hash[:ceiling_height])
+      end
+      if @hash[:volume]
+        os_thermal_zone.setVolume(@hash[:volume])
+      end
+
       # assign the story
       if @hash[:story]  # the users has specified the name of the story
         story = openstudio_model.getBuildingStoryByName(@hash[:story])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.22.3
+  version: 2.23.1
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -187,6 +187,8 @@ files:
 - lib/from_openstudio/material/window_simpleglazsys.rb
 - lib/from_openstudio/model.rb
 - lib/from_openstudio/model_object.rb
+- lib/from_openstudio/schedule/ruleset.rb
+- lib/from_openstudio/schedule/type_limit.rb
 - lib/from_openstudio/simulation/design_day.rb
 - lib/from_openstudio/simulation/parameter_model.rb
 - lib/from_openstudio/simulation/simulation_output.rb