honeybee-openstudio 2.26.0 → 2.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1b438f1be3e8c9905d69fdfbf5e8fb0253fcbfc9b463d981df1b22abbac3c81
-  data.tar.gz: 9f9a89d10c4128ad44166ea7c3af5ed4760e6970232bc4d5d80de72ba44ce6c2
+  metadata.gz: 68d5909ca4defd67e4437a988537724db7f6b1ae5691342278eb0c13c47cc033
+  data.tar.gz: ada6cbf89e0813172a16b4ffb1ac7fa78a26c6018e4b5a439586d886816a55e4
 SHA512:
-  metadata.gz: 8bedd71d378aba7a8ab3f54bc5b02af074f9a7159af90c3feb503e3ec06ae48aa5c2ceba9b2c3fbd52f474efaa80e1cc4e7a083e3cb0682dfb6e4a24c8bf33d2
-  data.tar.gz: 7191434a1ef1e64137f987ee541c8ba1d1ad6da668ef616ace2c30ecc0eb462dfbf620fff01a09cdf5d3854c4eade19d0c7e7395a95689661a14015abfe410b0
+  metadata.gz: 5e0eee873af2b06907cfed7ca2124d27ab9396f0d43eb8b1cf7895910d4645bd26b3dd84357f6954bfa85502fa4b61332fd7d2e2171d33a5a3797ede14e3ef3e
+  data.tar.gz: 1a784987d9db719a4cb703f2e47041f2612003fa3b1595a5c6bf017a2f895d9edbf494462cfd0141c9783f929a3c3450fd691f7457882427642acef706a9f528

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.26.0'
+  spec.version       = '2.28.0'
   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.22.1'
+gem 'honeybee-openstudio', '2.27.0'

data/lib/from_openstudio/construction/air.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'AirBoundaryConstructionAbridged'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(construction.nameString)
+        unless construction.displayName.empty?
+          hash[:display_name] = (construction.displayName.get).force_encoding("UTF-8")
+        end
         # check if boost optional object is empty
         unless construction.simpleMixingSchedule.empty?
           schedule = construction.simpleMixingSchedule.get

data/lib/from_openstudio/construction/opaque.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'OpaqueConstructionAbridged'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(construction.nameString)
+        unless construction.displayName.empty?
+          hash[:display_name] = (construction.displayName.get).force_encoding("UTF-8")
+        end
         hash[:materials] = []
         # get construction layers
         layers = construction.layers

data/lib/from_openstudio/construction/shade.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'ShadeConstruction'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(construction.nameString)
+        unless construction.displayName.empty?
+          hash[:display_name] = (construction.displayName.get).force_encoding("UTF-8")
+        end
         # get outermost construction layers
         layer = construction.layers[0]
         if layer.to_StandardGlazing.is_initialized

data/lib/from_openstudio/construction/window.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'WindowConstructionAbridged'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(construction.nameString)
+        unless construction.displayName.empty?
+          hash[:display_name] = (construction.displayName.get).force_encoding("UTF-8")
+        end
         hash[:materials] = []
         # get construction layers
         layers = construction.layers

data/lib/from_openstudio/construction_set.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'ConstructionSetAbridged'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(construction_set.nameString)
+        unless construction_set.displayName.empty?
+          hash[:display_name] = (construction_set.displayName.get).force_encoding("UTF-8")
+        end
         hash[:wall_set] = {}
         hash[:floor_set] = {}
         hash[:aperture_set] = {}

data/lib/from_openstudio/material/opaque.rb

@@ -41,11 +41,26 @@ module Honeybee
         hash[:type] = 'EnergyMaterial'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(material.nameString)
+        unless material.displayName.empty?
+          hash[:display_name] = (material.displayName.get).force_encoding("UTF-8")
+        end
         hash[:thickness] = material.thickness
         hash[:conductivity] = material.conductivity
         hash[:density] = material.density
         hash[:specific_heat] = material.specificHeat
-        hash[:roughness] = material.roughness
+        case material.roughness.downcase
+        when 'veryrough'
+          hash[:roughness] == 'VeryRough'
+        when 'mediumrough'
+          hash[:roughness] == 'MediumRough'
+        when 'mediumsmooth'
+          hash[:roughness] == 'MediumSmooth'
+        when 'verysmooth'
+          hash[:roughness] == 'VerySmooth'
+        # In case of Rough or Smooth
+        else
+          hash[:roughness] = material.roughness.titleize
+        end
         hash[:thermal_absorptance] = material.thermalAbsorptance
         hash[:solar_absorptance] = material.solarAbsorptance
         hash[:visible_absorptance] = material.visibleAbsorptance

data/lib/from_openstudio/material/opaque_no_mass.rb

@@ -41,12 +41,27 @@ module Honeybee
         hash[:type] = 'EnergyMaterialNoMass'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(material.nameString)
+        unless material.displayName.empty?
+          hash[:display_name] = (material.displayName.get).force_encoding("UTF-8")
+        end
         hash[:r_value] = material.thermalResistance
 
         if material.to_MasslessOpaqueMaterial.is_initialized
           # Roughness is a required property for OS MasslessOpaqueMaterial but isn't a listed
           # property for OS AirGap
-          hash[:roughness] = material.roughness
+          case material.roughness.downcase
+          when 'veryrough'
+            hash[:roughness] == 'VeryRough'
+          when 'mediumrough'
+            hash[:roughness] == 'MediumRough'
+          when 'mediumsmooth'
+            hash[:roughness] == 'MediumSmooth'
+          when 'verysmooth'
+            hash[:roughness] == 'VerySmooth'
+          # In case of Rough or Smooth
+          else
+            hash[:roughness] = material.roughness.titleize
+          end
           # check if boost optional object is empty
           unless material.thermalAbsorptance.empty?
             hash[:thermal_absorptance] = material.thermalAbsorptance.get

data/lib/from_openstudio/material/window_blind.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'EnergyWindowMaterialBlind'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(material.nameString)
+        unless material.displayName.empty?
+          hash[:display_name] = (material.displayName.get).force_encoding("UTF-8")
+        end
         hash[:slat_orientation] = material.slatOrientation
         hash[:slat_width] = material.slatWidth
         hash[:slat_separation] = material.slatSeparation

data/lib/from_openstudio/material/window_gas.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'EnergyWindowMaterialGas'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(material.nameString)
+        unless material.displayName.empty?
+          hash[:display_name] = (material.displayName.get).force_encoding("UTF-8")
+        end
         hash[:thickness] = material.thickness
         hash[:gas_type] = material.gasType
 

data/lib/from_openstudio/material/window_gas_custom.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'EnergyWindowMaterialGasCustom'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(material.nameString)
+        unless material.displayName.empty?
+            hash[:display_name] = (material.displayName.get).force_encoding("UTF-8")
+        end
         hash[:thickness] = material.thickness
         # check if boost optional object is empty
         unless material.customConductivityCoefficientA.empty?

data/lib/from_openstudio/material/window_gas_mixture.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'EnergyWindowMaterialGasMixture'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(material.nameString)
+        unless material.displayName.empty?
+            hash[:display_name] = (material.displayName.get).force_encoding("UTF-8")
+        end
         hash[:thickness] = material.thickness
         hash[:gas_types] = []
         hash[:gas_fractions] = []

data/lib/from_openstudio/material/window_glazing.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'EnergyWindowMaterialGlazing'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(material.nameString)
+        unless material.displayName.empty?
+            hash[:display_name] = (material.displayName.get).force_encoding("UTF-8")
+        end
         hash[:thickness] = material.thickness
         hash[:solar_transmittance] = material.solarTransmittance
         # check if boost optional object is empty

data/lib/from_openstudio/material/window_simpleglazsys.rb

@@ -41,6 +41,9 @@ module Honeybee
         hash[:type] = 'EnergyWindowMaterialSimpleGlazSys'
         # set hash values from OpenStudio Object
         hash[:identifier] = clean_name(material.nameString)
+        unless material.displayName.empty?
+          hash[:display_name] = (material.displayName.get).force_encoding("UTF-8")
+        end
         hash[:u_factor] = material.uFactor
         hash[:shgc] = material.solarHeatGainCoefficient
         # check if boost optional object is empty

data/lib/from_openstudio/schedule/fixed_interval.rb

@@ -40,6 +40,9 @@ module Honeybee
             hash = {}
             hash[:type] = 'ScheduleFixedIntervalAbridged'
             hash[:identifier] = clean_name(schedule_fixedinterval.nameString)
+            unless schedule_fixedinterval.displayName.empty?
+                hash[:display_name] = (schedule_fixedinterval.displayName.get).force_encoding("UTF-8")
+            end
             start_month = schedule_fixedinterval.startMonth
             start_day = schedule_fixedinterval.startDay
             if is_leap_year

data/lib/from_openstudio/schedule/ruleset.rb

@@ -41,6 +41,9 @@ module Honeybee
       hash[:type] = 'ScheduleRulesetAbridged'
       # set the primary (required) day schedules of the object
       hash[:identifier] = clean_name(schedule_ruleset.nameString)
+      unless schedule_ruleset.displayName.empty?
+        hash[:display_name] = (schedule_ruleset.displayName.get).force_encoding("UTF-8")
+      end
       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)

data/lib/from_openstudio/schedule/type_limit.rb

@@ -41,6 +41,9 @@ module Honeybee
       hash[:type] = 'ScheduleTypeLimit'
       # set hash values from OpenStudio Object
       hash[:identifier] = clean_name(schedule_type_limit.nameString)
+      unless schedule_type_limit.displayName.empty?
+        hash[:display_name] = (schedule_type_limit.displayName.get).force_encoding("UTF-8")
+      end
       # check if boost optional object is empty
       unless schedule_type_limit.lowerLimitValue.empty?
         hash[:lower_limit] = schedule_type_limit.lowerLimitValue.get

data/lib/honeybee/model.rb

@@ -40,7 +40,8 @@ module Honeybee
     def self.read_from_disk(file)
       hash = nil
       File.open(File.join(file), 'r') do |f|
-        hash = JSON.parse(f.read, symbolize_names: true)
+        hash = JSON.parse(File.read(f, :external_encoding => 'UTF-8',
+          :internal_encoding => 'UTF-8'), symbolize_names: true, encoding: 'UTF-8')
       end
       Model.new(hash)
     end

data/lib/honeybee/model_object.rb

@@ -30,6 +30,20 @@
 # *******************************************************************************
 
 module Honeybee
+  class FakeOptionalString
+    def initialize(str)
+      @str = str
+    end
+
+    def empty?
+      false
+    end
+
+    def get
+      @str
+    end
+  end
+
   class ModelObject
     # Base class from which all other objects in this module inherit.
     # Attributes and methods of this class should be overwritten in each inheriting object.
@@ -43,6 +57,7 @@ module Honeybee
       :universal_newline => true       # Always break lines with \n
     }
 
+
     def method_missing(sym, *args)
       name = sym.to_s
       aname = name.sub('=', '')
@@ -64,7 +79,8 @@ module Honeybee
     def self.read_from_disk(file)
       hash = nil
       File.open(File.join(file), 'r') do |f|
-        hash = JSON.parse(f.read, symbolize_names: true)
+        hash = JSON.parse(File.read(f, :external_encoding => 'UTF-8',
+          :internal_encoding => 'UTF-8'), symbolize_names: true, encoding: 'UTF-8')
       end
       new(hash)
     end
@@ -116,6 +132,21 @@ module Honeybee
       encode_str.gsub(/[^.A-Za-z0-9_-]/, '_').gsub(' ', '_')
     end
 
+    # Create methods to get and set display name
+    if !OpenStudio::Model::ModelObject.method_defined?(:displayName)
+      OpenStudio::Model::ModelObject.class_eval do
+        define_method(:displayName) do
+          result = additionalProperties.getFeatureAsString("DisplayName")
+          if !result.empty?
+            result = FakeOptionalString.new(result.get.force_encoding(Encoding::UTF_8))
+          end
+          result
+        end
+        define_method(:setDisplayName) do |value|
+          additionalProperties.setFeature("DisplayName", value)
+        end
+      end
+    end
 
   end # ModelObject
 end # Honeybee

data/lib/honeybee/simulation/parameter_model.rb

@@ -40,7 +40,8 @@ module Honeybee
     def self.read_from_disk(file)
       hash = nil
       File.open(File.join(file), 'r') do |f|
-        hash = JSON.parse(f.read, symbolize_names: true)
+        hash = JSON.parse(File.read(f, :external_encoding => 'UTF-8',
+          :internal_encoding => 'UTF-8'), symbolize_names: true, encoding: 'UTF-8')
       end
 
       SimulationParameter.new(hash)

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/construction/air.rb

@@ -46,6 +46,9 @@ module Honeybee
       os_construction = OpenStudio::Model::ConstructionAirBoundary.new(openstudio_model)
       os_construction.setName(@hash[:identifier])
       os_construction.setAirExchangeMethod('None')
+      unless @hash[:display_name].nil?
+        os_construction.setDisplayName(@hash[:display_name])
+      end
 
       os_construction
     end

data/lib/to_openstudio/construction/opaque.rb

@@ -46,6 +46,9 @@ module Honeybee
       # create construction and set identifier
       os_construction = OpenStudio::Model::Construction.new(openstudio_model)
       os_construction.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_construction.setDisplayName(@hash[:display_name])
+      end
 
       # create material vector
       os_materials = OpenStudio::Model::MaterialVector.new

data/lib/to_openstudio/construction/shade.rb

@@ -46,6 +46,9 @@ module Honeybee
 
       os_construction = OpenStudio::Model::Construction.new(openstudio_model)
       os_construction.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_construction.setDisplayName(@hash[:display_name])
+      end
       os_materials = OpenStudio::Model::MaterialVector.new
 
       # create standard glazing if is specular is true

data/lib/to_openstudio/construction/window.rb

@@ -46,7 +46,9 @@ module Honeybee
       # create construction and set identifier
       os_construction = OpenStudio::Model::Construction.new(openstudio_model)
       os_construction.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_construction.setDisplayName(@hash[:display_name])
+      end
       # create material vector
       os_materials = OpenStudio::Model::MaterialVector.new
       # loop through each layer and add to material vector

data/lib/to_openstudio/construction/windowshade.rb

@@ -51,7 +51,6 @@ module Honeybee
       shd_id = @hash[:window_construction][:identifier]
       @hash[:window_construction][:identifier] = unshd_id
       @hash[:identifier] = shd_id
-
       # create the unshaded construction
       unshd_constr_obj = WindowConstructionAbridged.new(@hash[:window_construction])
       @construction = unshd_constr_obj.to_openstudio(openstudio_model)
@@ -59,7 +58,9 @@ module Honeybee
       # create the shaded construction
       @shade_construction = OpenStudio::Model::Construction.new(openstudio_model)
       @shade_construction.setName(shd_id)
-
+      unless @hash[:display_name].nil?
+        @shade_construction.setDisplayName(@hash[:display_name])
+      end
       # create the layers of the unshaded construction into which we will insert the shade
       os_materials = []
       if @hash.key?(:layers)

data/lib/to_openstudio/construction_set.rb

@@ -30,7 +30,6 @@
 # *******************************************************************************
 
 require 'honeybee/construction_set'
-
 require 'to_openstudio/model_object'
 
 module Honeybee
@@ -46,7 +45,9 @@ module Honeybee
       # create the constructionset object
       os_constr_set = OpenStudio::Model::DefaultConstructionSet.new(openstudio_model)
       os_constr_set.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_constr_set.setDisplayName(@hash[:display_name])
+      end
       int_surf_const = OpenStudio::Model::DefaultSurfaceConstructions.new(openstudio_model)
       ext_surf_const = OpenStudio::Model::DefaultSurfaceConstructions.new(openstudio_model)
       grnd_surf_const = OpenStudio::Model::DefaultSurfaceConstructions.new(openstudio_model)

data/lib/to_openstudio/geometry/aperture.rb

@@ -114,6 +114,10 @@ module Honeybee
           os_subsurface.setName(@hash[:identifier])
         end
 
+        unless @hash[:display_name].nil?
+          os_subsurface.setDisplayName(@hash[:display_name])
+        end
+
         # assign the construction if it exists
         if @hash[:properties][:energy][:construction]
           construction_identifier = @hash[:properties][:energy][:construction]

data/lib/to_openstudio/geometry/door.rb

@@ -114,6 +114,10 @@ module Honeybee
           os_subsurface.setName(@hash[:identifier])
         end
 
+        unless @hash[:display_name].nil?
+          os_subsurface.setDisplayName(@hash[:display_name])
+        end
+
         # assign the construction if it exists
         if @hash[:properties][:energy][:construction]
           construction_identifier = @hash[:properties][:energy][:construction]

data/lib/to_openstudio/geometry/face.rb

@@ -60,6 +60,9 @@ module Honeybee
       # create the openstudio surface and assign the type
       os_surface = OpenStudio::Model::Surface.new(reordered_vertices, openstudio_model)
       os_surface.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_surface.setDisplayName(@hash[:display_name])
+      end
       os_surface.setSurfaceType(@hash[:face_type])
 
       # assign the construction if it is present

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,10 @@ 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
       os_thermal_zone = OpenStudio::Model::ThermalZone.new(openstudio_model)
       os_thermal_zone.setName(@hash[:identifier])
       os_space.setThermalZone(os_thermal_zone)

data/lib/to_openstudio/geometry/shade.rb

@@ -59,7 +59,9 @@ module Honeybee
 
       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
       # assign the construction if it exists
       if @hash[:properties][:energy][:construction]
         construction_identifier = @hash[:properties][:energy][:construction]

data/lib/to_openstudio/hvac/ideal_air.rb

@@ -40,7 +40,9 @@ module Honeybee
       # create the ideal air system and set the identifier
       os_ideal_air = OpenStudio::Model::ZoneHVACIdealLoadsAirSystem.new(openstudio_model)
       os_ideal_air.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_ideal_air.setDisplayName(@hash[:display_name])
+      end
       # assign the economizer type
       if @hash[:economizer_type]
         os_ideal_air.setOutdoorAirEconomizerType(@hash[:economizer_type])

data/lib/to_openstudio/load/electric_equipment.rb

@@ -47,6 +47,9 @@ module Honeybee
       os_electric_equip_def = OpenStudio::Model::ElectricEquipmentDefinition.new(openstudio_model)
       os_electric_equip = OpenStudio::Model::ElectricEquipment.new(os_electric_equip_def)
       os_electric_equip_def.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_electric_equip_def.setDisplayName(@hash[:display_name])
+      end
       os_electric_equip.setName(@hash[:identifier])
 
       # assign watts per area

data/lib/to_openstudio/load/gas_equipment.rb

@@ -48,6 +48,9 @@ module Honeybee
       os_gas_equip_def = OpenStudio::Model::GasEquipmentDefinition.new(openstudio_model)
       os_gas_equip = OpenStudio::Model::GasEquipment.new(os_gas_equip_def)
       os_gas_equip_def.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_gas_equip_def.setDisplayName(@hash[:display_name])
+      end
       os_gas_equip.setName(@hash[:identifier])
 
       # assign watts per space floor area

data/lib/to_openstudio/load/infiltration.rb

@@ -47,7 +47,9 @@ module Honeybee
       # create infiltration OpenStudio object and set identifier
       os_infilt = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(openstudio_model)
       os_infilt.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_infilt.setDisplayName(@hash[:display_name])
+      end
       # assign flow per surface
       os_infilt.setFlowperExteriorSurfaceArea(@hash[:flow_per_exterior_area])
 

data/lib/to_openstudio/load/lighting.rb

@@ -48,6 +48,9 @@ module Honeybee
       os_lights_def = OpenStudio::Model::LightsDefinition.new(openstudio_model)
       os_lights = OpenStudio::Model::Lights.new(os_lights_def)
       os_lights_def.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_lights_def.setDisplayName(@hash[:display_name])
+      end
       os_lights.setName(@hash[:identifier])
 
       # assign watts per space floor area

data/lib/to_openstudio/load/people.rb

@@ -48,6 +48,9 @@ module Honeybee
       os_people_def = OpenStudio::Model::PeopleDefinition.new(openstudio_model)
       os_people = OpenStudio::Model::People.new(os_people_def)
       os_people_def.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_people_def.setDisplayName(@hash[:display_name])
+      end
       os_people.setName(@hash[:identifier])
 
       # assign people per space floor area

data/lib/to_openstudio/load/process.rb

@@ -47,6 +47,9 @@ module Honeybee
       os_other_equip_def = OpenStudio::Model::OtherEquipmentDefinition.new(openstudio_model)
       os_other_equip = OpenStudio::Model::OtherEquipment.new(os_other_equip_def)
       os_other_equip_def.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_other_equip_def.setDisplayName(@hash[:display_name])
+      end
       os_other_equip.setName(@hash[:identifier])
 
       # assign watts

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/load/ventilation.rb

@@ -46,6 +46,9 @@ module Honeybee
       # create ventilation openstudio object and set identifier
       os_vent = OpenStudio::Model::DesignSpecificationOutdoorAir.new(openstudio_model)
       os_vent.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_vent.setDisplayName(@hash[:display_name])
+      end
 
       # assign air changes per hour if it exists
       if @hash[:air_changes_per_hour]

data/lib/to_openstudio/material/opaque.rb

@@ -46,6 +46,9 @@ module Honeybee
       # create standard opaque OpenStudio material
       os_opaque_mat = OpenStudio::Model::StandardOpaqueMaterial.new(openstudio_model)
       os_opaque_mat.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_opaque_mat.setDisplayName(@hash[:display_name])
+      end
       os_opaque_mat.setThickness(@hash[:thickness])
       os_opaque_mat.setConductivity(@hash[:conductivity])
       os_opaque_mat.setDensity(@hash[:density])

data/lib/to_openstudio/material/opaque_no_mass.rb

@@ -47,7 +47,9 @@ module Honeybee
       # create no mass material OpenStudio object and set identifier
       os_nomass_mat = OpenStudio::Model::MasslessOpaqueMaterial.new(openstudio_model)
       os_nomass_mat.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_nomass_mat.setDisplayName(@hash[:display_name])
+      end
       # assign thermal resistance
       os_nomass_mat.setThermalResistance(@hash[:r_value])
 

data/lib/to_openstudio/material/window_blind.rb

@@ -46,7 +46,9 @@ module Honeybee
       # create blind OpenStudio object
       os_blind = OpenStudio::Model::Blind.new(openstudio_model)
       os_blind.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_blind.setDisplayName(@hash[:display_name])
+      end
       # assign slat orientation
       if @hash[:slat_orientation]
         os_blind.setSlatOrientation(@hash[:slat_orientation])

data/lib/to_openstudio/material/window_gas.rb

@@ -46,7 +46,9 @@ module Honeybee
       # create window gas OpenStudio object
       os_window_gas = OpenStudio::Model::Gas.new(openstudio_model)
       os_window_gas.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_window_gas.setDisplayName(@hash[:display_name])
+      end
       # assign thickness
       if @hash[:thickness]
         os_window_gas.setThickness(@hash[:thickness])

data/lib/to_openstudio/material/window_gas_custom.rb

@@ -46,6 +46,9 @@ module Honeybee
       # create window gas openstudio object
       os_gas_custom = OpenStudio::Model::Gas.new(openstudio_model)
       os_gas_custom.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_gas_custom.setDisplayName(@hash[:display_name])
+      end
       os_gas_custom.setGasType('Custom')
       os_gas_custom.setConductivityCoefficientA(@hash[:conductivity_coeff_a])
       os_gas_custom.setViscosityCoefficientA(@hash[:viscosity_coeff_a])

data/lib/to_openstudio/material/window_gas_mixture.rb

@@ -46,7 +46,9 @@ module Honeybee
       # create the gas mixture
       os_gas_mixture = OpenStudio::Model::GasMixture.new(openstudio_model)
       os_gas_mixture.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_gas_mixture.setDisplayName(@hash[:display_name])
+      end
       # set the thickness
       if @hash[:thickness]
         os_gas_mixture.setThickness(@hash[:thickness])

data/lib/to_openstudio/material/window_glazing.rb

@@ -46,7 +46,9 @@ module Honeybee
       # create openstudio standard glazing object and set identifier
       os_glazing = OpenStudio::Model::StandardGlazing.new(openstudio_model)
       os_glazing.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_glazing.setDisplayName(@hash[:display_name])
+      end
       # assign thickness
       if @hash[:thickness]
         os_glazing.setThickness(@hash[:thickness])

data/lib/to_openstudio/material/window_shade.rb

@@ -46,7 +46,9 @@ module Honeybee
       # create openstudio shade object
       os_shade_mat = OpenStudio::Model::Shade.new(openstudio_model)
       os_shade_mat.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_shade_mat.setDisplayName(@hash[:display_name])
+      end
       # assign solar transmittance
       if @hash[:solar_transmittance]
         os_shade_mat.setSolarTransmittance(@hash[:solar_transmittance])

data/lib/to_openstudio/material/window_simpleglazsys.rb

@@ -48,7 +48,9 @@ module Honeybee
       os_simple_glazing.setName(@hash[:identifier])
       os_simple_glazing.setUFactor(@hash[:u_factor])
       os_simple_glazing.setSolarHeatGainCoefficient(@hash[:shgc])
-
+      unless @hash[:display_name].nil?
+        os_simple_glazing.setDisplayName(@hash[:display_name])
+      end
       # assign visible transmittance
       if @hash[:vt]
         os_simple_glazing.setVisibleTransmittance(@hash[:vt])

data/lib/to_openstudio/model.rb

@@ -203,9 +203,6 @@ module Honeybee
         puts 'Translating Context Shade Geometry'
       end
       create_orphaned_shades
-      create_orphaned_faces
-      create_orphaned_apertures
-      create_orphaned_doors
     end
 
     def create_materials(material_dicts, check_existing=false)

data/lib/to_openstudio/program_type.rb

@@ -46,7 +46,9 @@ module Honeybee
       # create openstudio space type object
       os_space_type = OpenStudio::Model::SpaceType.new(openstudio_model)
       os_space_type.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_space_type.setDisplayName(@hash[:display_name])
+      end
       # assign people
       if @hash[:people]
         people = PeopleAbridged.new(@hash[:people])

data/lib/to_openstudio/schedule/fixed_interval.rb

@@ -89,7 +89,9 @@ module Honeybee
       # create the new schedule
       os_fi_schedule = OpenStudio::Model::ScheduleFixedInterval.new(openstudio_model)
       os_fi_schedule.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_fi_schedule.setDisplayName(@hash[:display_name])
+      end
       # assign start date
       os_fi_schedule.setStartMonth(start_month)
       os_fi_schedule.setStartDay(start_day)
@@ -202,6 +204,9 @@ module Honeybee
       rowsToSkip = 1
       os_schedule_file = OpenStudio::Model::ScheduleFile.new(os_external_file, column, rowsToSkip)
       os_schedule_file.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_schedule_file.setDisplayName(@hash[:display_name])
+      end
       os_schedule_file.setInterpolatetoTimestep(interpolate)
       os_schedule_file.setMinutesperItem(interval_length)
 

data/lib/to_openstudio/schedule/ruleset.rb

@@ -47,7 +47,9 @@ module Honeybee
       # create openstudio schedule ruleset object
       os_sch_ruleset = OpenStudio::Model::ScheduleRuleset.new(openstudio_model)
       os_sch_ruleset.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_sch_ruleset.setDisplayName(@hash[:display_name])
+      end
       # assign schedule type limit
       sch_type_limit_obj = nil
       if @hash[:schedule_type_limit]
@@ -65,6 +67,9 @@ module Honeybee
         if day_schedule[:identifier] != def_day_id
           day_schedule_new = OpenStudio::Model::ScheduleDay.new(openstudio_model)
           day_schedule_new.setName(day_schedule[:identifier])
+          unless @hash[:display_name].nil?
+            day_schedule_new.setDisplayName(@hash[:display_name])
+          end
           unless sch_type_limit_obj.nil?
             day_schedule_new.setScheduleTypeLimits(sch_type_limit_obj)
           end

data/lib/to_openstudio/schedule/type_limit.rb

@@ -46,7 +46,9 @@ module Honeybee
       # create schedule type limits openstudio object
       os_type_limit = OpenStudio::Model::ScheduleTypeLimits.new(openstudio_model)
       os_type_limit.setName(@hash[:identifier])
-
+      unless @hash[:display_name].nil?
+        os_type_limit.setDisplayName(@hash[:display_name])
+      end
       if @hash[:lower_limit] != nil and @hash[:lower_limit] != {:type => 'NoLimit'}
         os_type_limit.setLowerLimitValue(@hash[:lower_limit])
       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.26.0
+  version: 2.28.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-12-02 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: