honeybee-openstudio 2.6.6 → 2.7.1

data/lib/{from_honeybee → to_openstudio}/model.rb

@@ -1,7 +1,7 @@
 # *******************************************************************************
-# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable 
+# 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:
 #
@@ -29,105 +29,15 @@
 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 # *******************************************************************************
 
-# import the core objects from which everything inherits
-require 'from_honeybee/extension'
-require 'from_honeybee/model_object'
-
-# import the compound objects that house the other objects
-require 'from_honeybee/construction_set'
-require 'from_honeybee/program_type'
-
-# import the geometry objects
-require 'from_honeybee/geometry/shade'
-require 'from_honeybee/geometry/door'
-require 'from_honeybee/geometry/aperture'
-require 'from_honeybee/geometry/face'
-require 'from_honeybee/geometry/room'
-
-# import the HVAC objects
-require 'from_honeybee/hvac/ideal_air'
-require 'from_honeybee/hvac/template'
-
-# import the construction objects
-require 'from_honeybee/construction/opaque'
-require 'from_honeybee/construction/window'
-require 'from_honeybee/construction/windowshade'
-require 'from_honeybee/construction/shade'
-require 'from_honeybee/construction/air'
-
-# import the material objects
-require 'from_honeybee/material/opaque'
-require 'from_honeybee/material/opaque_no_mass'
-require 'from_honeybee/material/window_gas'
-require 'from_honeybee/material/window_gas_mixture'
-require 'from_honeybee/material/window_gas_custom'
-require 'from_honeybee/material/window_blind'
-require 'from_honeybee/material/window_glazing'
-require 'from_honeybee/material/window_shade'
-require 'from_honeybee/material/window_simpleglazsys'
-
-# import the schedule objects
-require 'from_honeybee/schedule/type_limit'
-require 'from_honeybee/schedule/fixed_interval'
-require 'from_honeybee/schedule/ruleset'
-
-# import the load objects
-require 'from_honeybee/load/setpoint_thermostat'
-require 'from_honeybee/load/setpoint_humidistat'
-
-# import the ventilative cooling objects
-require 'from_honeybee/ventcool/simulation'
+require 'honeybee/model'
 
 require 'openstudio'
 
-
-module FromHoneybee
+module Honeybee
   class Model
-    attr_reader :errors, :warnings
-
-    # Read Ladybug Energy Model JSON from disk
-    def self.read_from_disk(file)
-      hash = nil
-      File.open(File.join(file), 'r') do |f|
-        hash = JSON.parse(f.read, symbolize_names: true)
-      end
-      Model.new(hash)
-    end
 
-    # Load ModelObject from symbolized hash
-    def initialize(hash)
-      # initialize class variable @@extension only once
-      @@extension ||= Extension.new
-      @@schema ||= @@extension.schema
-      @@standards ||= @@extension.standards
-
-      @hash = hash
-      @type = @hash[:type]
-      raise 'Unknown model type' if @type.nil?
-      raise "Incorrect model type '#{@type}'" unless @type == 'Model'
-    end
+    attr_reader :openstudio_model
 
-    # check if the model is valid
-    def valid?
-      if Gem.loaded_specs.has_key?("json-schema")
-        return validation_errors.empty?
-      else
-        return true
-      end
-    end
-
-    # return detailed model validation errors
-    def validation_errors
-      if Gem.loaded_specs.has_key?("json-schema")
-        require 'json-schema'
-        JSON::Validator.fully_validate(@@schema, @hash)
-      end
-    end
-
-    def defaults
-      @@schema[:components][:schemas][:ModelEnergyProperties][:properties]
-    end
-    
     # convert to openstudio model, clears errors and warnings
     def to_openstudio_model(openstudio_model=nil, log_report=true)
       @errors = []
@@ -180,6 +90,16 @@ module FromHoneybee
       $interior_afn_srf_hash = Hash.new  # track whether an adjacent surface is already in the AFN
 
       # create all of the non-geometric model elements
+      if log_report  # schedules are used by all other objects and come first
+        puts 'Translating Schedules'
+      end
+      if @hash[:properties][:energy][:schedule_type_limits]
+        create_schedule_type_limits(@hash[:properties][:energy][:schedule_type_limits])
+      end
+      if @hash[:properties][:energy][:schedules]
+        create_schedules(@hash[:properties][:energy][:schedules])
+      end
+
       if log_report
         puts 'Translating Materials'
       end
@@ -193,7 +113,7 @@ module FromHoneybee
       if @hash[:properties][:energy][:constructions]
         create_constructions(@hash[:properties][:energy][:constructions])
       end
-      
+
       if log_report
         puts 'Translating ConstructionSets'
       end
@@ -201,16 +121,6 @@ module FromHoneybee
         create_construction_sets(@hash[:properties][:energy][:construction_sets])
       end
 
-      if log_report
-        puts 'Translating Schedules'
-      end
-      if @hash[:properties][:energy][:schedule_type_limits]
-        create_schedule_type_limits(@hash[:properties][:energy][:schedule_type_limits])
-      end
-      if @hash[:properties][:energy][:schedules]
-        create_schedules(@hash[:properties][:energy][:schedules])
-      end
-
       if log_report
         puts 'Translating ProgramTypes'
       end
@@ -450,7 +360,7 @@ module FromHoneybee
         @hash[:rooms].each do |room|
           room_object = Room.new(room)
           openstudio_room = room_object.to_openstudio(@openstudio_model)
-          
+
           # for rooms with setpoint objects definied in the ProgramType, make a new thermostat
           if room[:properties][:energy][:program_type] && !room[:properties][:energy][:setpoint]
             thermal_zone = openstudio_room.thermalZone()
@@ -471,7 +381,7 @@ module FromHoneybee
             end
           end
         end
-      
+
         # create mixing objects between Rooms
         $air_mxing_array.each do |air_mix_props|
           zone_mixing = OpenStudio::Model::ZoneMixing.new(air_mix_props[0])
@@ -549,7 +459,7 @@ module FromHoneybee
           end
         end
       end
-    end 
+    end
 
     def create_orphaned_shades
       if @hash[:orphaned_shades]
@@ -574,14 +484,14 @@ module FromHoneybee
         raise "Orphaned Apertures are not translatable to OpenStudio."
       end
     end
-    
+
     def create_orphaned_doors
       if @hash[:orphaned_doors]
         raise "Orphaned Doors are not translatable to OpenStudio."
       end
     end
 
-    #TODO: create runlog for errors. 
-    
+    #TODO: create runlog for errors.
+
   end # Model
-end # FromHoneybee
+end # Honeybee

data/lib/to_openstudio/model_object.rb

@@ -0,0 +1,52 @@
+# *******************************************************************************
+# 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'
+
+require 'openstudio'
+
+module Honeybee
+  class ModelObject
+
+    attr_reader :openstudio_object
+
+    # find an equivalent existing object in the openstudio model, return nil if not found
+    def find_existing_openstudio_object(openstudio_model)
+      raise 'find_existing_openstudio_object is not yet implemented for this ModelObject.'
+    end
+
+    # create a new object in the openstudio model and return it
+    def to_openstudio(openstudio_model)
+      raise 'to_openstudio is not yet implemented for this ModelObject.'
+    end
+
+  end # ModelObject
+end # Honeybee

data/lib/{from_honeybee → to_openstudio}/program_type.rb

@@ -1,7 +1,7 @@
 # *******************************************************************************
-# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable 
+# 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:
 #
@@ -29,45 +29,25 @@
 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 # *******************************************************************************
 
-require 'from_honeybee/extension'
-require 'from_honeybee/model_object'
-require 'from_honeybee/load/people'
-require 'from_honeybee/load/lighting'
-require 'from_honeybee/load/electric_equipment'
-require 'from_honeybee/load/gas_equipment'
-require 'from_honeybee/load/infiltration'
-require 'from_honeybee/load/ventilation'
-require 'from_honeybee/load/setpoint_thermostat'
-require 'from_honeybee/load/setpoint_humidistat'
-
-require 'openstudio'
-
-module FromHoneybee
-  class ProgramTypeAbridged < ModelObject
-    attr_reader :errors, :warnings
-
-    def initialize(hash = {})
-      super(hash)
-  
-      raise "Incorrect model type '#{@type}'" unless @type == 'ProgramTypeAbridged'
-    end
-  
-    def defaults
-      @@schema[:components][:schemas][:ProgramTypeAbridged][:properties]
-    end
-  
+require 'honeybee/program_type'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class ProgramTypeAbridged
+
     def find_existing_openstudio_object(openstudio_model)
       model_space_type = openstudio_model.getSpaceTypeByName(@hash[:identifier])
       return model_space_type.get unless model_space_type.empty?
       nil
     end
-  
-    def to_openstudio(openstudio_model)    
+
+    def to_openstudio(openstudio_model)
       # create openstudio space type object
       os_space_type = OpenStudio::Model::SpaceType.new(openstudio_model)
       os_space_type.setName(@hash[:identifier])
 
-      # assign people 
+      # assign people
       if @hash[:people]
         people = PeopleAbridged.new(@hash[:people])
         os_people = people.to_openstudio(openstudio_model)
@@ -117,8 +97,8 @@ module FromHoneybee
       os_space_type
     end
 
-  end #ProgramTypeAbridged 
-end #FromHoneybee
+  end #ProgramTypeAbridged
+end #Honeybee
 
 
 

data/lib/{from_honeybee → to_openstudio}/schedule/fixed_interval.rb

@@ -1,7 +1,7 @@
 # *******************************************************************************
-# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable 
+# 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:
 #
@@ -29,29 +29,19 @@
 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 # *******************************************************************************
 
-require 'from_honeybee/extension'
-require 'from_honeybee/model_object'
-
-module FromHoneybee
-  class ScheduleFixedIntervalAbridged < ModelObject
-    attr_reader :errors, :warnings
+require 'honeybee/schedule/fixed_interval'
 
-    def initialize(hash = {})
-      super(hash)
+require 'to_openstudio/model_object'
 
-      raise "Incorrect model type '#{@type}'" unless @type == 'ScheduleFixedIntervalAbridged'
-    end
-
-    def defaults
-      @@schema[:components][:schemas][:ScheduleFixedIntervalAbridged][:properties]
-    end
+module Honeybee
+  class ScheduleFixedIntervalAbridged
 
     def find_existing_openstudio_object(openstudio_model)
       model_schedule = openstudio_model.getScheduleFixedIntervalByName(@hash[:identifier])
       return model_schedule.get unless model_schedule.empty?
       nil
     end
-  
+
     def to_openstudio(openstudio_model)
       # create the new schedule
       os_fi_schedule = OpenStudio::Model::ScheduleFixedInterval.new(openstudio_model)
@@ -92,13 +82,13 @@ module FromHoneybee
         interval_length = 60 / timestep
         os_fi_schedule.setIntervalLength(interval_length)
       end
-      openstudio_interval_length = OpenStudio::Time.new(0, 0, interval_length) 
+      openstudio_interval_length = OpenStudio::Time.new(0, 0, interval_length)
 
       # assign the values as a timeseries
       year_description = openstudio_model.getYearDescription
 
       # set is leap year = true in case start date has 3 integers
-      if @hash[:start_date][2] 
+      if @hash[:start_date][2]
         year_description.setIsLeapYear(true)
       end
 
@@ -110,6 +100,6 @@ module FromHoneybee
 
       os_fi_schedule
     end
-    
+
   end #ScheduleFixedIntervalAbridged
-end #FromHoneybee
+end #Honeybee

data/lib/{from_honeybee → to_openstudio}/schedule/ruleset.rb

@@ -1,7 +1,7 @@
 # *******************************************************************************
-# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable 
+# 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:
 #
@@ -29,23 +29,12 @@
 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 # *******************************************************************************
 
-require 'from_honeybee/model_object'
-
-require 'openstudio'
+require 'honeybee/schedule/ruleset'
 
-module FromHoneybee
-  class ScheduleRulesetAbridged < ModelObject
-    attr_reader :errors, :warnings
+require 'to_openstudio/model_object'
 
-    def initialize(hash = {})
-      super(hash)
-
-      raise "Incorrect model type '#{@type}'" unless @type == 'ScheduleRulesetAbridged'
-    end
-
-    def defaults
-      @@schema[:components][:schemas][:ScheduleRulesetAbridged][:properties]
-    end
+module Honeybee
+  class ScheduleRulesetAbridged
 
     def find_existing_openstudio_object(openstudio_model)
       object = openstudio_model.getScheduleRulesetByName(@hash[:identifier])
@@ -69,24 +58,30 @@ module FromHoneybee
       end
 
       # loop through day schedules and create openstudio schedule day object
+      def_day_id = @hash[:default_day_schedule]
+      def_day_hash = nil
       @hash[:day_schedules].each do |day_schedule|
-        day_schedule_new = OpenStudio::Model::ScheduleDay.new(openstudio_model)
-        day_schedule_new.setName(day_schedule[:identifier])
-        unless sch_type_limit_obj.nil?
-          day_schedule_new.setScheduleTypeLimits(sch_type_limit_obj)
-        end
-        values_day_new = day_schedule[:values]
-        times_day_new = day_schedule[:times]
-        times_day_new.delete_at(0)  # Remove [0, 0] from array at index 0.
-        times_day_new.push([24, 0])  # Add [24, 0] at index 0
-        values_day_new.each_index do |i|
-          time_until = OpenStudio::Time.new(0, times_day_new[i][0], times_day_new[i][1], 0)
-          day_schedule_new.addValue(time_until, values_day_new[i])
+        if day_schedule[:identifier] != def_day_id
+          day_schedule_new = OpenStudio::Model::ScheduleDay.new(openstudio_model)
+          day_schedule_new.setName(day_schedule[:identifier])
+          unless sch_type_limit_obj.nil?
+            day_schedule_new.setScheduleTypeLimits(sch_type_limit_obj)
+          end
+          values_day_new = day_schedule[:values]
+          times_day_new = day_schedule[:times]
+          times_day_new.delete_at(0)  # Remove [0, 0] from array at index 0.
+          times_day_new.push([24, 0])  # Add [24, 0] at index 0
+          values_day_new.each_index do |i|
+            time_until = OpenStudio::Time.new(0, times_day_new[i][0], times_day_new[i][1], 0)
+            day_schedule_new.addValue(time_until, values_day_new[i])
+          end
+        else
+          def_day_hash = day_schedule
         end
       end
 
-      # assign holiday schedule      
-      if @hash[:holiday_schedule]      
+      # assign holiday schedule
+      if @hash[:holiday_schedule]
         holiday_schedule = openstudio_model.getScheduleDayByName(@hash[:holiday_schedule])
         unless holiday_schedule.empty?
           holiday_schedule_object = holiday_schedule.get
@@ -97,7 +92,7 @@ module FromHoneybee
         end
       end
 
-      # assign summer design day schedule 
+      # assign summer design day schedule
       if @hash[:summer_designday_schedule]
         summer_design_day = openstudio_model.getScheduleDayByName(@hash[:summer_designday_schedule])
         unless summer_design_day.empty?
@@ -113,22 +108,26 @@ module FromHoneybee
           winter_design_day_object = winter_design_day.get
           os_sch_ruleset.setWinterDesignDaySchedule(winter_design_day_object)
         end
-      end       
-    
+      end
+
       # assign default day schedule
-      default_day_schedule = openstudio_model.getScheduleDayByName(@hash[:default_day_schedule])
-      unless default_day_schedule.empty?
-        default_day_schedule_object = default_day_schedule.get
-        values = default_day_schedule_object.values
-        times = default_day_schedule_object.times
-        values.each_index do |i|
-          os_sch_ruleset.defaultDaySchedule.addValue(times[i], values[i])
-        end
+      def_day_sch = os_sch_ruleset.defaultDaySchedule
+      def_day_sch.setName(def_day_id)
+      unless sch_type_limit_obj.nil?
+        def_day_sch.setScheduleTypeLimits(sch_type_limit_obj)
+      end
+      values_day_new = def_day_hash[:values]
+      times_day_new = def_day_hash[:times]
+      times_day_new.delete_at(0)  # Remove [0, 0] from array at index 0.
+      times_day_new.push([24, 0])  # Add [24, 0] at index 0
+      values_day_new.each_index do |i|
+        time_until = OpenStudio::Time.new(0, times_day_new[i][0], times_day_new[i][1], 0)
+        def_day_sch.addValue(time_until, values_day_new[i])
       end
 
       # assign schedule rules
       if @hash[:schedule_rules]
-        @hash[:schedule_rules].each do |rule|          
+        @hash[:schedule_rules].each do |rule|
           openstudio_schedule_rule = OpenStudio::Model::ScheduleRule.new(os_sch_ruleset)
           openstudio_schedule_rule.setApplySunday(rule[:apply_sunday])
           openstudio_schedule_rule.setApplyMonday(rule[:apply_monday])
@@ -165,4 +164,4 @@ module FromHoneybee
     end
 
   end #ScheduleRulesetAbridged
-end #FromHoneybee
+end #Honeybee