honeybee-openstudio 2.6.9 → 2.7.0

data/lib/from_openstudio/geometry/face.rb

@@ -0,0 +1,174 @@
+# *******************************************************************************
+# 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/model_object'
+
+module Honeybee
+  class Face < ModelObject
+
+    def self.from_surface(surface, site_transformation)
+      hash = {}
+      hash[:type] = 'Face'
+      hash[:identifier] = clean_identifier(surface.nameString)
+      hash[:display_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)
+      hash[:face_type] = face_type_from_surface(surface)
+      hash[:boundary_condition] = boundary_condition_from_surface(surface)
+
+      apertures = apertures_from_surface(surface, site_transformation)
+      hash[:apertures] = apertures if !apertures.empty?
+
+      doors = doors_from_surface(surface, site_transformation)
+      hash[:doors] = doors if !doors.empty?
+
+      indoor_shades = indoor_shades_from_surface(surface)
+      hash[:indoor_shades] = indoor_shades if !indoor_shades.empty?
+
+      outdoor_shades = outdoor_shades_from_surface(surface)
+      hash[:outdoor_shades] = outdoor_shades if !outdoor_shades.empty?
+
+      hash
+    end
+
+    def self.properties_from_surface(surface)
+      hash = {}
+      hash[:type] = 'FacePropertiesAbridged'
+      hash[:energy] = energy_properties_from_surface(surface)
+      hash
+    end
+
+    def self.energy_properties_from_surface(surface)
+      hash = {}
+      hash[:type] = 'FaceEnergyPropertiesAbridged'
+
+      construction = surface.construction
+      if !construction.empty?
+        hash[:construction] = clean_identifier(construction.get.nameString)
+      end
+
+      hash
+    end
+
+    def self.geometry_from_surface(surface, site_transformation)
+      result = {}
+      result[:type] = 'Face3D'
+      result[:boundary] = []
+      vertices = site_transformation * surface.vertices
+      vertices.each do |v|
+        result[:boundary] << [v.x, v.y, v.z]
+      end
+      result
+    end
+
+    def self.face_type_from_surface(surface)
+      # "Wall", "Floor", "RoofCeiling", "AirBoundary"
+      result = nil
+      surface_type = surface.surfaceType
+      if surface.isAirWall
+        result = 'AirBoundary'
+      elsif /Wall/i.match(surface_type)
+        result = 'Wall'
+      elsif /Floor/i.match(surface_type)
+        result = 'Floor'
+      elsif /RoofCeiling/i.match(surface_type)
+        result = 'RoofCeiling'
+      end
+      result
+    end
+
+    def self.boundary_condition_from_surface(surface)
+      result = {}
+      surface_type = surface.surfaceType
+      adjacent_surface = surface.adjacentSurface
+      if !adjacent_surface.empty?
+        adjacent_space = clean_identifier(adjacent_surface.get.space.get.nameString)
+        adjacent_surface = clean_identifier(adjacent_surface.get.nameString)
+        result = {type: 'Surface', boundary_condition_objects: [adjacent_surface, adjacent_space]}
+      elsif surface.isGroundSurface
+        result = {type: 'Ground'}
+      elsif surface_type == 'Adiabatic'
+        result = {type: 'Adiabatic'}
+      else
+        sun_exposure = (surface.sunExposure == 'SunExposed')
+        wind_exposure = (surface.windExposure == 'WindExposed')
+        view_factor = surface.viewFactortoGround
+        if view_factor.empty?
+          view_factor = {type: 'Autocalculate'}
+        else
+          view_factor = view_factor.get
+        end
+        result = {type: 'Outdoors', sun_exposure: sun_exposure,
+                  wind_exposure: wind_exposure, view_factor: view_factor}
+      end
+      result
+    end
+
+    def self.apertures_from_surface(surface, site_transformation)
+      result = []
+      surface.subSurfaces.each do |sub_surface|
+        sub_surface_type = sub_surface.subSurfaceType
+        if !/Door/i.match(sub_surface_type)
+          result << Aperture.from_sub_surface(sub_surface, site_transformation)
+        end
+      end
+      result
+    end
+
+    def self.doors_from_surface(surface, site_transformation)
+      result = []
+      surface.subSurfaces.each do |sub_surface|
+        sub_surface_type = sub_surface.subSurfaceType
+        if /Door/i.match(sub_surface_type)
+          result << Door.from_sub_surface(sub_surface, site_transformation)
+        end
+      end
+      result
+    end
+
+    def self.indoor_shades_from_surface(surface)
+      []
+    end
+
+    def self.outdoor_shades_from_surface(surface)
+      result = []
+      surface.shadingSurfaceGroups.each do |shading_surface_group|
+        site_transformation = shading_surface_group.siteTransformation
+        shading_surface_group.shadingSurfaces.each do |shading_surface|
+          result << Shade.from_shading_surface(shading_surface, site_transformation)
+        end
+      end
+      result
+    end
+
+  end #Face
+end #Honeybee

data/lib/from_openstudio/geometry/room.rb

@@ -0,0 +1,121 @@
+# *******************************************************************************
+# 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/model_object'
+
+module Honeybee
+  class Room < ModelObject
+
+    def self.from_space(space)
+      hash = {}
+      hash[:type] = 'Room'
+      hash[:identifier] = clean_identifier(space.nameString)
+      hash[:display_name] = space.nameString
+      hash[:user_data] = {space: space.handle.to_s}
+      hash[:properties] = properties_from_space(space)
+
+      site_transformation = space.siteTransformation
+      hash[:faces] = faces_from_space(space, site_transformation)
+
+      indoor_shades = indoor_shades_from_space(space)
+      hash[:indoor_shades] = indoor_shades if !indoor_shades.empty?
+
+      outdoor_shades = outdoor_shades_from_space(space)
+      hash[:outdoor_shades] = outdoor_shades if !outdoor_shades.empty?
+
+      multipler = multiplier_from_space(space)
+      hash[:multipler] = multipler if multipler
+
+      story = story_from_space(space)
+      hash[:story] = story if story
+
+      hash
+    end
+
+    def self.properties_from_space(space)
+      hash = {}
+      hash[:type] = 'RoomPropertiesAbridged'
+      hash[:energy] = self.energy_properties_from_space(space)
+      hash
+    end
+
+    def self.energy_properties_from_space(space)
+      hash = {}
+      hash[:type] = 'RoomEnergyPropertiesAbridged'
+      hash
+    end
+
+    def self.faces_from_space(space, site_transformation)
+      result = []
+      space.surfaces.each do |surface|
+        result << Face.from_surface(surface, site_transformation)
+      end
+      result
+    end
+
+    def self.indoor_shades_from_space(space)
+      []
+    end
+
+    def self.outdoor_shades_from_space(space)
+      result = []
+      space.shadingSurfaceGroups.each do |shading_surface_group|
+        # skip if attached to a surface or sub_surface
+        if !shading_surface_group.shadedSurface.empty? || !shading_surface_group.shadedSubSurface.empty?
+          next
+        end
+
+        site_transformation = shading_surface_group.siteTransformation
+        shading_surface_group.shadingSurfaces.each do |shading_surface|
+          result << Shade.from_shading_surface(shading_surface, site_transformation)
+        end
+      end
+      result
+    end
+
+    def self.multiplier_from_space(space)
+      multiplier = space.multiplier
+      if multiplier != 1
+        return multiplier
+      end
+      nil
+    end
+
+    def self.story_from_space(space)
+      story = space.buildingStory
+      if !story.empty?
+        return clean_identifier(story.get.nameString)
+      end
+      nil
+    end
+
+  end # Aperture
+end # Honeybee

data/lib/from_openstudio/geometry/shade.rb

@@ -0,0 +1,87 @@
+# *******************************************************************************
+# 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/geometry/shade'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class Shade
+
+    def self.from_shading_surface(shading_surface, site_transformation)
+      hash = {}
+      hash[:type] = 'Shade'
+      hash[:identifier] = clean_identifier(shading_surface.nameString)
+      hash[:display_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)
+
+      hash
+    end
+
+    def self.properties_from_shading_surface(shading_surface)
+      hash = {}
+      hash[:type] = 'ShadePropertiesAbridged'
+      hash[:energy] = energy_properties_from_shading_surface(shading_surface)
+      hash
+    end
+
+    def self.energy_properties_from_shading_surface(shading_surface)
+      hash = {}
+      hash[:type] = 'ShadeEnergyPropertiesAbridged'
+
+      construction = shading_surface.construction
+      if !construction.empty?
+        hash[:construction] = clean_identifier(construction.get.nameString)
+      end
+
+      transmittance_schedule = shading_surface.transmittanceSchedule
+      if !transmittance_schedule.empty?
+        hash[:transmittance_schedule] = clean_identifier(transmittance_schedule.get.nameString)
+      end
+
+      hash
+    end
+
+    def self.geometry_from_shading_surface(shading_surface, site_transformation)
+      result = {}
+      result[:type] = 'Face3D'
+      result[:boundary] = []
+      vertices = site_transformation * shading_surface.vertices
+      vertices.each do |v|
+        result[:boundary] << [v.x, v.y, v.z]
+      end
+      result
+    end
+
+  end #Shade
+end #Honeybee

data/lib/from_openstudio/model.rb

@@ -0,0 +1,123 @@
+# *******************************************************************************
+# 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/model'
+
+require 'from_openstudio/geometry/room'
+require 'from_openstudio/geometry/shade'
+
+require 'openstudio'
+
+module Honeybee
+  class Model
+
+    # Create Ladybug Energy Model JSON from OpenStudio Model
+    def self.translate_from_openstudio(openstudio_model)
+      hash = {}
+      hash[:type] = 'Model'
+      hash[:identifier] = 'Model'
+      hash[:display_name] = 'Model'
+      hash[:units] = 'Meters'
+      hash[:tolerance] = 0.01
+      hash[:angle_tolerance] = 1.0
+
+      hash[:properties] = properties_from_model(openstudio_model)
+
+      rooms = rooms_from_model(openstudio_model)
+      hash[:rooms] = rooms if !rooms.empty?
+
+      orphaned_shades = orphaned_shades_from_model(openstudio_model)
+      hash[:orphaned_shades] = orphaned_shades if !orphaned_shades.empty?
+
+      Model.new(hash)
+    end
+
+    # Create Ladybug Energy Model JSON from OSM file
+    def self.translate_from_osm_file(file)
+      vt = OpenStudio::OSVersion::VersionTranslator.new
+      openstudio_model = vt.loadModel(file)
+      raise "Cannot load OSM file at '#{}'" if openstudio_model.empty?
+      self.translate_from_openstudio(openstudio_model.get)
+    end
+
+    # Create Ladybug Energy Model JSON from gbXML file
+    def self.translate_from_gbxml_file(file)
+      translator = OpenStudio::GbXML::GbXMLReverseTranslator.new
+      openstudio_model = translator.loadModel(file)
+      raise "Cannot load gbXML file at '#{}'" if openstudio_model.empty?
+      self.translate_from_openstudio(openstudio_model.get)
+    end
+
+    # Create Ladybug Energy Model JSON from IDF file
+    def self.translate_from_idf_file(file)
+      translator = OpenStudio::EnergyPlus::ReverseTranslator.new
+      openstudio_model = translator.loadModel(file)
+      raise "Cannot load IDF file at '#{}'" if openstudio_model.empty?
+      self.translate_from_openstudio(openstudio_model.get)
+    end
+
+    def self.properties_from_model(openstudio_model)
+      hash = {}
+      hash[:type] = 'ModelProperties'
+      hash
+    end
+
+    def self.energy_properties_from_model(openstudio_model)
+      hash = {}
+      hash[:type] = 'ModelEnergyProperties'
+      hash[:energy] = energy_properties_from_model(openstudio_model)
+      hash
+    end
+
+    def self.rooms_from_model(openstudio_model)
+      result = []
+      openstudio_model.getSpaces.each do |space|
+        result << Room.from_space(space)
+      end
+      result
+    end
+
+    def self.orphaned_shades_from_model(openstudio_model)
+      result = []
+      openstudio_model.getShadingSurfaceGroups.each do |shading_surface_group|
+        shading_surface_type = shading_surface_group.shadingSurfaceType
+        if shading_surface_type == 'Site' || shading_surface_type == 'Building'
+          site_transformation = shading_surface_group.siteTransformation
+          shading_surface_group.shadingSurfaces.each do |shading_surface|
+            result << Shade.from_shading_surface(shading_surface, site_transformation)
+          end
+        end
+      end
+      result
+    end
+
+  end # Model
+end # Honeybee