honeybee-openstudio 2.22.4 → 2.23.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8767065c98f72114b89b1d16304efe93ca0003a357f647954b0beed6989b1ec
-  data.tar.gz: 1ed4757de90face39cbc8309e45d5e1a872288bab0f9240da9a9d4b8db18dada
+  metadata.gz: 70d85a158c3143c24582c3f1c29fd12c166da8ce20add49553cf9c64d6a320f2
+  data.tar.gz: 63e8a77445232cd5f90fd3d3effdcd8816cd3982e50116ecca67e6656940589d
 SHA512:
-  metadata.gz: '0925da969e4768649654327dd2574ab5cd4caec284ae804c42ae7fb772e139aae63d852a52b1406fb81e1c6db0fa1658f170c29389614bf0e3cc4d4054a428d4'
-  data.tar.gz: '091488d2fa18fa7f06452c43fea7d6559fdaa8591f04c9b5fa8732d65b0119e39aa789ba2c82ce806b5346aceabc44423ecd9c5d103d9f2cbb3d31e615f1e4d6'
+  metadata.gz: bdcbacab7a8801c1a24044e9eef069bca9ffde80734fcb77c78b147492ba7ee30fdf6f3b67faf8990f8c5b11fdd5b60970e397423c933a904c8cf46f9da2ca00
+  data.tar.gz: 7488acf2edc55f7fc2bfb5b555b1095fc1e1493eba59044969c6c09003087aa103d628c2816f06ff9e89703f680f579190e615be0422249330beacd05851fbc0

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.4'
+  spec.version       = '2.23.2'
   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/shade.rb

@@ -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/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,77 @@
+# *******************************************************************************
+# 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'
+      elsif unit_type == 'Controlmode'
+        unit_type = 'Control'
+      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,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/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.4
+  version: 2.23.2
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-10 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