honeybee-openstudio 2.27.0 → 2.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84b66e4746d59f77468d6ab7e342a1c7feb57806e692173dee69ec248f5a4b1f
-  data.tar.gz: e9e0476441a4f9261292b2d78d49c15c1d113de599b6ef7dcebfb3c79cc72888
+  metadata.gz: f46d6897c585ff7082971de6ff24b62e1d4213697bb9e3fb08a9b4eefd069a6d
+  data.tar.gz: 4c231dc4b6622e5d9871eddb54e6b6e32ebb5302183372845ea690552f0407f3
 SHA512:
-  metadata.gz: a260b02b02b502f29c2cebfa55c9b9938aef96f0b2bcdfe4044cc3a28af14290615ad6e1b9afde6747cd6d11e4e18a0974f793683af251a3d5743ca20450d37b
-  data.tar.gz: 8022e1f14fb2a5f700e7f5dedfc5d7a26e481b463ebef2cac6b381ee798d3906508edd9508717e07b7dcb6f967a5a9f2ed9bd7c9c85aaafa79d822d6b74fea90
+  metadata.gz: 8a9192fca6bf36375576eb5fd7efb3f104e4ed34b2607e8d80c36ce60f272cdd7c62b1badb4a43f1c0daa0e813b63e5dffc407e25032172c045d7523b5f05e7d
+  data.tar.gz: e2533183332b489d8ba275feddf184c56f7cdca3a5bb561ce9ae7ad6af3177b9983b57872a1623c316a1d4b3ddea060dec1ab2714429edbe1a450928c5a5bb01

data/.github/workflows/ci.yaml

@@ -15,8 +15,8 @@ jobs:
       run: |
         echo $(pwd)
         echo $(ls)
-        docker pull nrel/openstudio:3.2.0
-        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.2.0
+        docker pull nrel/openstudio:3.3.0
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.3.0
         docker exec -t test pwd
         docker exec -t test ls
         docker exec -t test bundle update

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.3'
+  gem 'openstudio-extension', '0.5.1'
 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.27.0'
+  spec.version       = '2.28.1'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 
@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   end
 
   spec.add_dependency 'json_pure'
-  spec.add_dependency 'openstudio-extension', '0.4.3'
-  spec.add_dependency 'openstudio-standards', '~> 0.2.14'
+  spec.add_dependency 'openstudio-extension', '0.5.1'
+  spec.add_dependency 'openstudio-standards', '~> 0.2.15'
 end

data/lib/files/urbanopt_Gemfile

@@ -37,4 +37,4 @@ else
 end
 
 # include the honeybee-openstudio-gem
-gem 'honeybee-openstudio', '2.26.0'
+gem 'honeybee-openstudio', '2.27.0'

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] = clean_name(construction.nameString)
+        hash[:identifier] = clean_name(construction.nameString) + ' Shade'
         unless construction.displayName.empty?
           hash[:display_name] = (construction.displayName.get).force_encoding("UTF-8")
         end

data/lib/from_openstudio/geometry/aperture.rb

@@ -72,7 +72,7 @@ module Honeybee
       unless sub_surface.isConstructionDefaulted
         construction = sub_surface.construction
         if !construction.empty?
-          constr_id = clean_identifier(construction.get.nameString)
+          constr_id = clean_name(construction.get.nameString)
           unless $window_constructions[constr_id].nil?
             hash[:construction] = constr_id
           end

data/lib/from_openstudio/geometry/door.rb

@@ -72,7 +72,7 @@ module Honeybee
       unless sub_surface.isConstructionDefaulted
         construction = sub_surface.construction
         if !construction.empty?
-          constr_id = clean_identifier(construction.get.nameString)
+          constr_id = clean_name(construction.get.nameString)
           if hash[:is_glass] && !$window_constructions[constr_id].nil?
             hash[:construction] = constr_id
           elsif !hash[:is_glass] && !$opaque_constructions[constr_id].nil?

data/lib/from_openstudio/geometry/face.rb

@@ -74,7 +74,7 @@ module Honeybee
       unless surface.isConstructionDefaulted
         construction = surface.construction
         if !construction.empty?
-          constr_id = clean_identifier(construction.get.nameString)
+          constr_id = clean_name(construction.get.nameString)
           unless $opaque_constructions[constr_id].nil?
             hash[:construction] = constr_id
           end

data/lib/from_openstudio/geometry/shade.rb

@@ -62,7 +62,7 @@ module Honeybee
       unless shading_surface.isConstructionDefaulted
         construction = shading_surface.construction
         if !construction.empty?
-          const_name = clean_identifier(construction.get.nameString)
+          const_name = clean_name(construction.get.nameString) + ' Shade'
           hash[:construction] = const_name
           unless $shade_constructions.has_key?(const_name)
             const_obj = construction.get
@@ -74,7 +74,7 @@ module Honeybee
 
       transmittance_schedule = shading_surface.transmittanceSchedule
       if !transmittance_schedule.empty?
-        trans_sch_name = clean_identifier(transmittance_schedule.get.nameString)
+        trans_sch_name = clean_name(transmittance_schedule.get.nameString)
         # Check whether schedules other than schedule ruleset or schedule fixed interval are
         # being assigned
         unless $schedules[trans_sch_name].nil?

data/lib/measures/from_honeybee_model_to_gbxml/measure.rb

@@ -91,13 +91,6 @@ class FromHoneybeeModelToGbxml < OpenStudio::Measure::ModelMeasure
     os_model = honeybee_model.to_openstudio_model(model)
     STDOUT.flush
 
-    # make sure the zone name is different from the space name to comply with gbXML
-    zones = os_model.getThermalZones()
-    zones.each do |zone|
-      zone_name = zone.name.to_s + '_Zone'
-      zone.setName(zone_name)
-    end
-
     # convert the OpenStudio model into a gbXML Model
     output_file_path = runner.getStringArgumentValue('output_file_path', user_arguments)
     if output_file_path && !output_file_path.empty?

data/lib/to_openstudio/geometry/aperture.rb

@@ -160,5 +160,50 @@ module Honeybee
 
       return result
     end
+
+    def to_openstudio_shade(openstudio_model, shading_surface_group)
+      # get the vertices from the aperture
+      if @hash[:geometry][:vertices].nil?
+        hb_verts = @hash[:geometry][:boundary]
+      else
+        hb_verts = @hash[:geometry][:vertices]
+      end
+
+      # create the openstudio shading surface
+      os_vertices = OpenStudio::Point3dVector.new
+      hb_verts.each do |vertex|
+        os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
+      end
+      reordered_vertices = OpenStudio.reorderULC(os_vertices)
+
+      os_shading_surface = OpenStudio::Model::ShadingSurface.new(reordered_vertices, openstudio_model)
+      os_shading_surface.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_shading_surface.setDisplayName(@hash[:display_name])
+      end
+
+      # get the approriate construction id
+      construction_id = nil
+      if @hash[:properties][:energy][:construction]
+        construction_id = @hash[:properties][:energy][:construction]
+      else
+        construction_id = 'Generic Double Pane'
+      end
+  
+      # assign the construction
+      unless construction_id.nil?
+        construction = openstudio_model.getConstructionByName(construction_id)
+        unless construction.empty?
+          os_construction = construction.get
+          os_shading_surface.setConstruction(os_construction)
+        end
+      end
+
+      # add the shade to the group
+      os_shading_surface.setShadingSurfaceGroup(shading_surface_group)
+
+      os_shading_surface
+    end
+  
   end # Aperture
 end # Honeybee

data/lib/to_openstudio/geometry/door.rb

@@ -154,4 +154,51 @@ module Honeybee
       return result
     end
   end # Door
+
+  def to_openstudio_shade(openstudio_model, shading_surface_group)
+    # get the vertices from the door
+    if @hash[:geometry][:vertices].nil?
+      hb_verts = @hash[:geometry][:boundary]
+    else
+      hb_verts = @hash[:geometry][:vertices]
+    end
+
+    # create the openstudio shading surface
+    os_vertices = OpenStudio::Point3dVector.new
+    hb_verts.each do |vertex|
+      os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
+    end
+    reordered_vertices = OpenStudio.reorderULC(os_vertices)
+
+    os_shading_surface = OpenStudio::Model::ShadingSurface.new(reordered_vertices, openstudio_model)
+    os_shading_surface.setName(@hash[:identifier])
+    unless @hash[:display_name].nil?
+      os_shading_surface.setDisplayName(@hash[:display_name])
+    end
+
+    # get the approriate construction id
+    construction_id = nil
+    if @hash[:properties][:energy][:construction]
+      construction_id = @hash[:properties][:energy][:construction]
+    elsif @hash[:is_glass] == true
+      construction_id = 'Generic Double Pane'
+    else
+      construction_id = 'Generic Exterior Door'
+    end
+
+    # assign the construction
+    unless construction_id.nil?
+      construction = openstudio_model.getConstructionByName(construction_id)
+      unless construction.empty?
+        os_construction = construction.get
+        os_shading_surface.setConstruction(os_construction)
+      end
+    end
+
+    # add the shade to the group
+    os_shading_surface.setShadingSurfaceGroup(shading_surface_group)
+
+    os_shading_surface
+  end
+
 end # Honeybee

data/lib/to_openstudio/geometry/face.rb

@@ -184,5 +184,70 @@ module Honeybee
 
       os_surface
     end
+
+    def to_openstudio_shade(openstudio_model, shading_surface_group)
+      # get the vertices from the face
+      if @hash[:geometry][:vertices].nil?
+        hb_verts = @hash[:geometry][:boundary]
+      else
+        hb_verts = @hash[:geometry][:vertices]
+      end
+
+      # create the openstudio shading surface
+      os_vertices = OpenStudio::Point3dVector.new
+      hb_verts.each do |vertex|
+        os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
+      end
+      reordered_vertices = OpenStudio.reorderULC(os_vertices)
+
+      os_shading_surface = OpenStudio::Model::ShadingSurface.new(reordered_vertices, openstudio_model)
+      os_shading_surface.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_shading_surface.setDisplayName(@hash[:display_name])
+      end
+
+      # get the approriate construction id
+      construction_id = nil
+      if @hash[:properties][:energy][:construction]
+        construction_id = @hash[:properties][:energy][:construction]
+      elsif @hash[:face_type] == 'Wall'
+        construction_id = 'Generic Exterior Wall'
+      elsif @hash[:face_type] == 'RoofCeiling'
+        construction_id = 'Generic Roof'
+      elsif @hash[:face_type] == 'Floor'
+        construction_id = 'Generic Exposed Floor'
+      end
+  
+      # assign the construction
+      unless construction_id.nil?
+        construction = openstudio_model.getConstructionByName(construction_id)
+        unless construction.empty?
+          os_construction = construction.get
+          os_shading_surface.setConstruction(os_construction)
+        end
+      end
+
+      # add the shade to the group
+      os_shading_surface.setShadingSurfaceGroup(shading_surface_group)
+
+      # convert the apertures to shade objects
+      if @hash[:apertures]
+        @hash[:apertures].each do |aperture|
+          hb_aperture = Aperture.new(aperture)
+          os_subsurface_aperture = hb_aperture.to_openstudio_shade(openstudio_model, shading_surface_group)
+        end
+      end
+
+      # convert the apertures to shade objects
+      if @hash[:doors]
+        @hash[:doors].each do |door|
+          hb_door = Door.new(door)
+          os_subsurface_door = hb_door.to_openstudio_shade(openstudio_model, shading_surface_group)
+        end
+      end
+
+      os_shading_surface
+    end
+
   end # Face
 end # Honeybee

data/lib/to_openstudio/geometry/room.rb

@@ -39,7 +39,7 @@ module Honeybee
     attr_reader :unique_space_type
 
     def find_existing_openstudio_object(openstudio_model)
-      model_space = openstudio_model.getSpaceByName(@hash[:identifier])
+      model_space = openstudio_model.getSpaceByName(@hash[:identifier] + '_Space')
       return model_space.get unless model_space.empty?
       nil
     end
@@ -75,7 +75,7 @@ module Honeybee
     def to_openstudio(openstudio_model)
       # create the space and thermal zone
       os_space = OpenStudio::Model::Space.new(openstudio_model)
-      os_space.setName(@hash[:identifier])
+      os_space.setName(@hash[:identifier] + '_Space')
       unless @hash[:display_name].nil?
         os_space.setDisplayName(@hash[:display_name])
       end

data/lib/to_openstudio/load/service_hot_water.rb

@@ -234,7 +234,7 @@ module Honeybee
       # create water use equipment + connection and set identifier
       os_shw_def = OpenStudio::Model::WaterUseEquipmentDefinition.new(openstudio_model)
       os_shw = OpenStudio::Model::WaterUseEquipment.new(os_shw_def)
-      unique_id = @hash[:identifier] + '..' + os_space.nameString
+      unique_id = @hash[:identifier] + '..' + os_space.nameString[0...-6]
       os_shw_def.setName(unique_id)
       os_shw.setName(unique_id)
 

data/lib/to_openstudio/model.rb

@@ -591,28 +591,43 @@ module Honeybee
         shading_surface_group = OpenStudio::Model::ShadingSurfaceGroup.new(@openstudio_model)
         shading_surface_group.setShadingSurfaceType('Building')
         @hash[:orphaned_shades].each do |shade|
-        shade_object = Shade.new(shade)
-        openstudio_shade = shade_object.to_openstudio(@openstudio_model)
-        openstudio_shade.setShadingSurfaceGroup(shading_surface_group)
+          shade_object = Shade.new(shade)
+          openstudio_shade = shade_object.to_openstudio(@openstudio_model)
+          openstudio_shade.setShadingSurfaceGroup(shading_surface_group)
         end
       end
     end
 
     def create_orphaned_faces
       if @hash[:orphaned_faces]
-        raise "Orphaned Faces are not translatable to OpenStudio."
+        shading_surface_group = OpenStudio::Model::ShadingSurfaceGroup.new(@openstudio_model)
+        shading_surface_group.setShadingSurfaceType('Building')
+        @hash[:orphaned_faces].each do |face|
+          face_object = Face.new(face)
+          openstudio_shade = face_object.to_openstudio_shade(@openstudio_model, shading_surface_group)
+        end
       end
     end
 
     def create_orphaned_apertures
       if @hash[:orphaned_apertures]
-        raise "Orphaned Apertures are not translatable to OpenStudio."
+        shading_surface_group = OpenStudio::Model::ShadingSurfaceGroup.new(@openstudio_model)
+        shading_surface_group.setShadingSurfaceType('Building')
+        @hash[:orphaned_apertures].each do |ap|
+          ap_object = Aperture.new(ap)
+          openstudio_shade = ap_object.to_openstudio_shade(@openstudio_model, shading_surface_group)
+        end
       end
     end
 
     def create_orphaned_doors
       if @hash[:orphaned_doors]
-        raise "Orphaned Doors are not translatable to OpenStudio."
+        shading_surface_group = OpenStudio::Model::ShadingSurfaceGroup.new(@openstudio_model)
+        shading_surface_group.setShadingSurfaceType('Building')
+        @hash[:orphaned_doors].each do |dr|
+          dr_object = Door.new(dr)
+          openstudio_shade = dr_object.to_openstudio_shade(@openstudio_model, shading_surface_group)
+        end
       end
     end
 

data/lib/to_openstudio/simulation/parameter_model.rb

@@ -145,13 +145,24 @@ module Honeybee
           os_sizing_par.setCoolingSizingFactor(@hash[:sizing_parameter][:cooling_factor])
         end
         # set any design days
+        db_temps = []
         if @hash[:sizing_parameter][:design_days]
           @hash[:sizing_parameter][:design_days].each do |des_day|
             des_day_object = DesignDay.new(des_day)
             os_des_day = des_day_object.to_openstudio(@openstudio_model)
+            db_temps << des_day[:dry_bulb_condition][:dry_bulb_max]
           end
         end
       end
+      # use the average of design day temperatures to set the water mains temperature
+      os_water_mains = @openstudio_model.getSiteWaterMainsTemperature 
+      os_water_mains.setCalculationMethod('Correlation')
+      if db_temps.length > 0
+        os_water_mains.setAnnualAverageOutdoorAirTemperature((db_temps.max + db_temps.min) / 2)
+      else  # just use some dummy values so that the simulation does not fail
+        os_water_mains.setAnnualAverageOutdoorAirTemperature(12)
+      end
+      os_water_mains.setMaximumDifferenceInMonthlyAverageOutdoorAirTemperatures(4)
 
       # set Outputs for the simulation
       if @hash[:output]
@@ -238,9 +249,6 @@ module Honeybee
         os_site.setTerrain(@hash[:terrain_type])
       end
 
-      # ensure water mains temperatures are written
-      os_water_mains = @openstudio_model.getSiteWaterMainsTemperature 
-      os_water_mains.setCalculationMethod('CorrelationFromWeatherFile')
     end
 
   end #SimulationParameter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.27.0
+  version: 2.28.1
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2021-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,28 +117,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: openstudio-standards
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.14
+        version: 0.2.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.14
+        version: 0.2.15
 description: Library and measures for translating between Honeybee JSON schema and
   OpenStudio Model schema (OSM).
 email: