honeybee-openstudio 0

data/lib/files/Honeybee.rb

@@ -0,0 +1,113 @@
+# *******************************************************************************
+# 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 'urbanopt/reporting'
+require 'openstudio/common_measures'
+require 'openstudio/model_articulation'
+
+require 'json'
+
+module URBANopt
+    module Scenario
+      class HoneybeeMapper < SimulationMapperBase
+
+      # class level variables
+      @@instance_lock = Mutex.new
+      @@osw = nil
+      @@geometry = nil
+
+      def initialize()
+
+        # do initialization of class variables in thread safe way
+        @@instance_lock.synchronize do
+            if @@osw.nil?
+
+              # load the OSW for this class
+              osw_path = File.join(File.dirname(__FILE__), 'honeybee_workflow.osw')
+              File.open(osw_path, 'r') do |file|
+                @@osw = JSON.parse(file.read, symbolize_names: true)
+              end
+
+            # configure OSW with extension gem paths for measures and files
+            # all extension gems must be required before this line
+            @@osw = OpenStudio::Extension.configure_osw(@@osw)
+            end
+          end
+      end
+
+      def create_osw(scenario, features, feature_names)
+
+        if features.size != 1
+          raise "Mapper currently cannot simulate more than one feature at a time."
+        end
+        feature = features[0]
+        feature_id = feature.id
+        feature_type = feature.type
+        feature_name = feature.name
+        if feature_names.size == 1
+          feature_name = feature_names[0]
+        end
+
+        # deep clone of @@osw before we configure it
+        osw = Marshal.load(Marshal.dump(@@osw))
+
+        # set the name and description of the OSW to reference this particular feature
+        osw[:name] = feature_name
+        osw[:description] = feature_name
+
+        if feature_type == 'Building'
+            # set the honeybee JSON key to the honeybee_model measure
+            OpenStudio::Extension.set_measure_argument(
+                osw, 'from_honeybee_model', 'model_json', feature.detailed_model_filename)
+
+            # check if there is a HVAC key in the feature JSON properties
+            building_hash = feature.to_hash
+            if building_hash.key?(:system_type)
+              # assume the typical building measure is in the OSW and add the system type
+              OpenStudio::Extension.set_measure_argument(
+                  osw, 'create_typical_building_from_model', 'system_type', system_type)
+            end
+
+            # add the feature id and name to the reporting measure
+            OpenStudio::Extension.set_measure_argument(
+              osw, 'default_feature_reports', 'feature_id', feature_id)
+            OpenStudio::Extension.set_measure_argument(
+              osw, 'default_feature_reports', 'feature_name', feature_name)
+            OpenStudio::Extension.set_measure_argument(
+              osw, 'default_feature_reports', 'feature_type', feature_type)
+
+        end
+        return osw
+      end
+
+    end #HoneybeeMapper
+  end #Scenario
+end #URBANopt

data/lib/files/honeybee_workflow.osw

@@ -0,0 +1,48 @@
+{
+  "seed_file": null,
+  "weather_file": null,
+  "measure_paths": [],
+  "file_paths": [],
+  "run_directory": null,
+  "steps": [
+    {
+      "measure_dir_name": "from_honeybee_simulation_parameter",
+      "arguments": {
+        "simulation_parameter_json": "simulation_parameter.json"
+      }
+    },{
+      "measure_dir_name": "from_honeybee_model",
+      "arguments": {
+        "model_json": "multi_zone_model.json"
+      }
+    },{
+      "name": "create_typical_building_from_model",
+      "measure_dir_name": "create_typical_building_from_model",
+      "arguments": {
+        "__SKIP__": true,
+        "template": "90.1-2004",
+        "add_constructions": false,
+        "add_space_type_loads": false,
+        "add_elevators": false,
+        "add_exterior_lights": false,
+        "add_exhaust": false,
+        "add_swh": false,
+        "add_refrigeration": false,
+        "remove_objects": false,
+        "system_type": "Inferred",
+        "add_hvac": true,
+        "use_upstream_args": false
+      }
+    },{
+      "measure_dir_name": "default_feature_reports",
+      "arguments": {
+        "__SKIP__": true,
+        "feature_id": null,
+        "feature_name": null,
+        "feature_type": null
+      }
+    }
+  ],
+  "name": null,
+  "description": null
+}

data/lib/files/urbanopt_Gemfile

@@ -0,0 +1,32 @@
+source 'http://rubygems.org'
+
+ruby '~> 2.5.0'
+
+allow_local = ENV['FAVOR_LOCAL_GEMS']
+
+if allow_local && File.exist?('../openstudio-model-articulation-gem')
+  gem 'openstudio-model-articulation', path: '../openstudio-model-articulation-gem'
+elsif allow_local
+  gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
+else
+  gem 'openstudio-model-articulation', '0.2.0'
+end
+
+if allow_local && File.exist?('../urbanopt-geojson-gem')
+  gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
+elsif allow_local
+  gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
+else
+  gem 'urbanopt-geojson', '~> 0.4.0'
+end
+
+if allow_local && File.exist?('../urbanopt-reporting-gem')
+  gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
+elsif allow_local
+  gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
+else
+  gem 'urbanopt-reporting', '~> 0.2.1'
+end
+
+# include the honeybee-openstudio-gem
+gem 'honeybee-openstudio', '2.7.3'

data/lib/from_openstudio.rb

@@ -0,0 +1,49 @@
+# *******************************************************************************
+# 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.
+# *******************************************************************************
+
+# import the honeybee objects which we will extend
+require 'honeybee'
+
+# extend the compound objects that house the other objects
+require 'from_openstudio/model'
+require 'from_openstudio/model_object'
+
+# extend the geometry objects
+require 'from_openstudio/geometry/aperture'
+require 'from_openstudio/geometry/door'
+require 'from_openstudio/geometry/face'
+require 'from_openstudio/geometry/room'
+require 'from_openstudio/geometry/shade'
+
+# extend the simulation objects
+require 'from_openstudio/simulation/design_day'
+require 'from_openstudio/simulation/parameter_model'
+require 'from_openstudio/simulation/simulation_output'

data/lib/from_openstudio/geometry/aperture.rb

@@ -0,0 +1,136 @@
+# *******************************************************************************
+# 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/aperture'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class Aperture < ModelObject
+
+    def self.from_sub_surface(sub_surface, site_transformation)
+      hash = {}
+      hash[:type] = 'Aperture'
+      hash[:identifier] = clean_identifier(sub_surface.nameString)
+      hash[:display_name] = sub_surface.nameString
+      hash[:user_data] = {handle: sub_surface.handle.to_s}
+      hash[:properties] = properties_from_sub_surface(sub_surface)
+      hash[:geometry] = geometry_from_sub_surface(sub_surface, site_transformation)
+      hash[:boundary_condition] = boundary_condition_from_sub_surface(sub_surface)
+
+      sub_surface_type = sub_surface.subSurfaceType
+      hash[:is_operable] = (sub_surface_type == 'OperableWindow')
+
+      indoor_shades = indoor_shades_from_sub_surface(sub_surface)
+      hash[:indoor_shades] = indoor_shades if !indoor_shades.empty?
+
+      outdoor_shades = outdoor_shades_from_sub_surface(sub_surface)
+      hash[:outdoor_shades] = outdoor_shades if !outdoor_shades.empty?
+
+      hash
+    end
+
+    def self.properties_from_sub_surface(sub_surface)
+      hash = {}
+      hash[:type] = 'AperturePropertiesAbridged'
+      hash[:energy] = energy_properties_from_sub_surface(sub_surface)
+      hash
+    end
+
+    def self.energy_properties_from_sub_surface(sub_surface)
+      hash = {}
+      hash[:type] = 'ApertureEnergyPropertiesAbridged'
+
+      construction = sub_surface.construction
+      if !construction.empty?
+        hash[:construction] = clean_identifier(construction.get.nameString)
+      end
+
+      hash
+    end
+
+    def self.geometry_from_sub_surface(sub_surface, site_transformation)
+      result = {}
+      result[:type] = 'Face3D'
+      result[:boundary] = []
+      vertices = site_transformation * sub_surface.vertices
+      vertices.each do |v|
+        result[:boundary] << [v.x, v.y, v.z]
+      end
+      result
+    end
+
+    def self.boundary_condition_from_sub_surface(sub_surface)
+      result = {}
+      surface = sub_surface.surface.get
+      surface_type = surface.surfaceType
+      adjacent_sub_surface = sub_surface.adjacentSubSurface
+      if !adjacent_sub_surface.empty?
+        adjacent_space = clean_identifier(adjacent_sub_surface.get.space.get.nameString)
+        adjacent_surface = clean_identifier(adjacent_sub_surface.get.surface.get.nameString)
+        adjacent_sub_surface = clean_identifier(adjacent_sub_surface.get.nameString)
+        result = {type: 'Surface', boundary_condition_objects: [adjacent_sub_surface, 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 = sub_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.indoor_shades_from_sub_surface(sub_surface)
+      []
+    end
+
+    def self.outdoor_shades_from_sub_surface(sub_surface)
+      result = []
+      sub_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 # Aperture
+end # Honeybee

data/lib/from_openstudio/geometry/door.rb

@@ -0,0 +1,136 @@
+# *******************************************************************************
+# 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/door'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class Door
+
+  def self.from_sub_surface(sub_surface, site_transformation)
+      hash = {}
+      hash[:type] = 'Door'
+      hash[:identifier] = clean_identifier(sub_surface.nameString)
+      hash[:display_name] = sub_surface.nameString
+      hash[:user_data] = {handle: sub_surface.handle.to_s}
+      hash[:properties] = properties_from_sub_surface(sub_surface)
+      hash[:geometry] = geometry_from_sub_surface(sub_surface, site_transformation)
+      hash[:boundary_condition] = boundary_condition_from_sub_surface(sub_surface)
+
+      sub_surface_type = sub_surface.subSurfaceType
+      hash[:is_glass] = (sub_surface_type == 'GlassDoor')
+
+      indoor_shades = indoor_shades_from_sub_surface(sub_surface)
+      hash[:indoor_shades] = indoor_shades if !indoor_shades.empty?
+
+      outdoor_shades = outdoor_shades_from_sub_surface(sub_surface)
+      hash[:outdoor_shades] = outdoor_shades if !outdoor_shades.empty?
+
+      hash
+    end
+
+    def self.properties_from_sub_surface(sub_surface)
+      hash = {}
+      hash[:type] = 'DoorPropertiesAbridged'
+      hash[:energy] = energy_properties_from_sub_surface(sub_surface)
+      hash
+    end
+
+    def self.energy_properties_from_sub_surface(sub_surface)
+      hash = {}
+      hash[:type] = 'DoorEnergyPropertiesAbridged'
+
+      construction = sub_surface.construction
+      if !construction.empty?
+        hash[:construction] = clean_identifier(construction.get.nameString)
+      end
+
+      hash
+    end
+
+    def self.geometry_from_sub_surface(sub_surface, site_transformation)
+      result = {}
+      result[:type] = 'Face3D'
+      result[:boundary] = []
+      vertices = site_transformation * sub_surface.vertices
+      vertices.each do |v|
+        result[:boundary] << [v.x, v.y, v.z]
+      end
+      result
+    end
+
+    def self.boundary_condition_from_sub_surface(sub_surface)
+      result = {}
+      surface = sub_surface.surface.get
+      surface_type = surface.surfaceType
+      adjacent_sub_surface = sub_surface.adjacentSubSurface
+      if !adjacent_sub_surface.empty?
+        adjacent_space = clean_identifier(adjacent_sub_surface.get.space.get.nameString)
+        adjacent_surface = clean_identifier(adjacent_sub_surface.get.surface.get.nameString)
+        adjacent_sub_surface = clean_identifier(adjacent_sub_surface.get.nameString)
+        result = {type: 'Surface', boundary_condition_objects: [adjacent_sub_surface, 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 = sub_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.indoor_shades_from_sub_surface(sub_surface)
+      []
+    end
+
+    def self.outdoor_shades_from_sub_surface(sub_surface)
+      result = []
+      sub_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 # Door
+end # Honeybee