honeybee-openstudio 2.22.2 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5392435198119a686f3699148121914e8bd91ce5664c5b6499b9c992718655ae
-  data.tar.gz: 41671a1887d378797a955d26d48211476754dcf31f178fa13ba8689a62e50826
+  metadata.gz: 8b1713bd43ce02933e6b62917cfd588f51b34474ab42cc964fac0707892ef6cb
+  data.tar.gz: 1b63c7e6ef5ef775b1c6312170fc11cb2117685141e6e6c00d39bc14a4dcb7e9
 SHA512:
-  metadata.gz: 486f13b92b50320910c4612c91fa6baf1050f618e844253a3462652d969878cbb99dd67c31569eda343467dc29d10d969d88f626c49d814e4fcc96805ab60780
-  data.tar.gz: e7baa65945989b5c72169530e40529a7ed2a598980ca3176c51c3fed079f75467353d408e605ae5b47e9a9566147b7ce1006346e9e8d4f3740c03f9cef9a7fff
+  metadata.gz: b2ce15cb4c8761569e16fae90f1a378a34d4a662abe027458714ed2c11004e84d833dec91ab7795d14d019ada20803a96969ac08c9eb0e8b8f9f725d60911fd5
+  data.tar.gz: 2ed1a4870310d697989c9af03079522af38459cba61280b2053e8b2e59cade74318e5ec43380ca85512ec74258d02b2f13305206c2a3a24e97395de428a95266

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 if File.exist?('../OpenStudio-extension-gem')  # local development copy
   gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
 else  # get it from rubygems.org
-  gem 'openstudio-extension', '0.4.2'
+  gem 'openstudio-extension', '0.4.3'
 end
 
 # coveralls gem is used to generate coverage reports through CI

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.2'
+  spec.version       = '2.23.0'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 
@@ -29,10 +29,10 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency "json-schema",    "~> 2.8.1"
     spec.add_development_dependency "rake",           "~> 13.0"
     spec.add_development_dependency "rspec",          "~> 3.9"
-    spec.add_development_dependency "rubocop",        "~> 0.54.0"
+    spec.add_development_dependency "rubocop",        "~> 1.15.0"
   end
 
   spec.add_dependency 'json_pure'
-  spec.add_dependency 'openstudio-extension', '0.4.2'
-  spec.add_dependency 'openstudio-standards', '~> 0.2.13'
+  spec.add_dependency 'openstudio-extension', '0.4.3'
+  spec.add_dependency 'openstudio-standards', '~> 0.2.14'
 end

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'
 
@@ -131,6 +133,10 @@ module Honeybee
       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
     end
@@ -266,5 +272,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,114 @@
+# *******************************************************************************
+# 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 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
+
+      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)
+      end
+
+      hash[:schedule_rules] = []
+      schedule_ruleset.scheduleRules.each do |schedule_rule|
+        hash[:schedule_rules] << ScheduleRulesetAbridged.from_schedule_rule(schedule_rule)
+      end
+
+      hash
+    end
+
+    def self.from_day_schedule(day_schedule)
+      hash = {}
+      hash[:type] = 'ScheduleDay'
+      hash[:identifier] = 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] = 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,63 @@
+# *******************************************************************************
+# 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] = 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
+      hash[:unit_type] = schedule_type_limit.unitType
+
+      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/face.rb

@@ -77,7 +77,7 @@ module Honeybee
 
           # assign the flow exponent if it's specified
           if vent_crack[:flow_exponent]
-            os_crack.	setAirMassFlowExponent(vent_crack[:flow_exponent])
+            os_crack.setAirMassFlowExponent(vent_crack[:flow_exponent])
           end
 
           # if it's a Surface boundary condition ensure the neighbor is not written as a duplicate

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])
@@ -349,8 +357,10 @@ module Honeybee
             if sub_f.adjacentSubSurface.empty?  # not an interior window that's already in the AFN
               vent_open = VentilationOpening.new(opening)
               open_fac = vent_open.to_openstudio_afn(openstudio_model, sub_f)
-              operable_subfs << sub_f
-              opening_factors << open_fac
+              unless open_fac.nil?  # nil is used for horizontal exterior skylights
+                operable_subfs << sub_f
+                opening_factors << open_fac
+              end
             end
           end
         end

data/lib/to_openstudio/ventcool/opening.rb

@@ -128,43 +128,69 @@ module Honeybee
     end
 
     def to_openstudio_afn(openstudio_model, parent)
-      # process the flow_coefficient_closed and set it to a very small number if it's 0
+      # get the tilt and BC of the parent so that we can use the correct AFN object
+      srf_tilt = parent.tilt.to_f * (180 / Math::PI)
+      srf_bc = parent.outsideBoundaryCondition.to_s
+
+      # process the flow_coefficient_closed and flow exponent
       if @hash[:flow_coefficient_closed] and @hash[:flow_coefficient_closed] != 0
         flow_coefficient = @hash[:flow_coefficient_closed]
       else
         flow_coefficient = 1.0e-09  # set it to a very small number
       end
-
-      # 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
-      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)
-
-      # assign the flow exponent when the opening is closed
-      if @hash[:flow_exponent_closed]
-        os_opening.setAirMassFlowExponentWhenOpeningisClosed(@hash[:flow_exponent_closed])
-      end
-      # assign the minimum difference for two-way flow
-      if @hash[:two_way_threshold]
-        os_opening.setMinimumDensityDifferenceforTwoWayFlow(@hash[:two_way_threshold])
-      end
-      # assign the discharge coefficient
-      if @hash[:discharge_coefficient]
-        os_opening.setDischargeCoefficient(@hash[:discharge_coefficient])
-      end
-
-      # create the AirflowNetworkSurface
-      os_afn_srf = parent.getAirflowNetworkSurface(os_opening)
 
-      # assign the opening area
+      # process the opening area
       if @hash[:fraction_area_operable]
         open_fac = @hash[:fraction_area_operable]
       else
         open_fac = defaults[:fraction_area_operable][:default]
       end
-      os_afn_srf.setWindowDoorOpeningFactorOrCrackFactor(open_fac)
+
+      # create an opening obj
+      if srf_tilt < 10 || srf_tilt > 170
+        if srf_bc == 'Outdoors'
+          # create a crack object to represent an exterior in-operable horizontal skylight
+          open_fac = nil
+          os_opening = OpenStudio::Model::AirflowNetworkCrack.new(
+            openstudio_model, flow_coefficient, flow_exponent, $afn_reference_crack)
+        else
+          # create a HorizontalOpening object to represent the interior horizontal window
+          discharge_coeff = defaults[:discharge_coefficient][:default].to_f
+          if srf_tilt < 10
+            slope_ang = 90 - srf_tilt
+          else
+            slope_ang = 90 - (180 - srf_tilt)
+          end
+          os_opening = OpenStudio::Model::AirflowNetworkHorizontalOpening .new(
+            openstudio_model, flow_coefficient, flow_exponent, slope_ang, discharge_coeff)
+        end
+      else
+        # create the simple opening object for the Aperture or Door using default values
+        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)
+
+        # assign the flow exponent when the opening is closed
+        if @hash[:flow_exponent_closed]
+          os_opening.setAirMassFlowExponentWhenOpeningisClosed(@hash[:flow_exponent_closed])
+        end
+        # assign the minimum difference for two-way flow
+        if @hash[:two_way_threshold]
+          os_opening.setMinimumDensityDifferenceforTwoWayFlow(@hash[:two_way_threshold])
+        end
+        # assign the discharge coefficient
+        if @hash[:discharge_coefficient]
+          os_opening.setDischargeCoefficient(@hash[:discharge_coefficient])
+        end
+      end
+
+      # create the AirflowNetworkSurface and assign the opening factor
+      os_afn_srf = parent.getAirflowNetworkSurface(os_opening)
+      unless open_fac.nil?
+        os_afn_srf.setWindowDoorOpeningFactorOrCrackFactor(open_fac)
+      end
 
       open_fac
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.22.2
+  version: 2.23.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,14 +89,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
@@ -117,28 +117,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.3
 - !ruby/object:Gem::Dependency
   name: openstudio-standards
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: 0.2.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: 0.2.14
 description: Library and measures for translating between Honeybee JSON schema and
   OpenStudio Model schema (OSM).
 email:
@@ -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