honeybee-openstudio 1.8.1

data/lib/from_honeybee/model_object.rb

@@ -0,0 +1,110 @@
+# *******************************************************************************
+# 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 'openstudio'
+
+module FromHoneybee
+  class ModelObject
+    # Base class from which all other ojbects in this module inherit.
+    # Attributes and methods of this class should be overwritten in each inheriting object.
+
+    attr_reader :errors, :warnings
+
+    def method_missing(sym, *args)
+      name = sym.to_s
+      aname = name.sub('=', '')
+      asym = aname.to_sym
+      is_getter = args.empty? && @hash.key?(asym)
+      is_setter = (name != aname) && (args.size == 1) && @hash.key?(asym)
+
+      if is_getter
+        return @hash[asym]
+      elsif is_setter
+        return @hash[asym] = args[0]
+      end
+
+      # do the regular thing
+      super
+    end
+
+    # Read ModelObject 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
+      new(hash)
+    end
+
+    # Load ModelObject from symbolized hash
+    def initialize(hash)
+      # initialize class variable @@extension only once
+      @@extension ||= Extension.new
+      @@schema ||= @@extension.schema
+
+      @hash = hash
+      @type = @hash[:type]
+      raise 'Unknown type' if @type.nil?
+      raise "Incorrect model type '#{@type}'" unless @type == @hash[:type]
+      @openstudio_object = nil
+    end
+
+    # hash containing the object defaults taken from the open API schema
+    def defaults
+      raise 'defaults not implemented for ModelObject, override in your class'
+    end
+
+    # check if the ModelObject is valid
+    def valid?
+      return validation_errors.empty?
+    end
+
+    # return detailed model validation errors
+    def validation_errors
+      if Gem.loaded_specs.has_key?("json-schema")
+        require 'json-schema'
+        # if this raises a 'Invalid fragment resolution for :fragment option' it is because @type 
+        # does not correspond to a definition in the schema
+        JSON::Validator.fully_validate(@@schema, @hash, :fragment => "#/definitions/#{@type}")
+      end
+    end
+
+    # 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 # FromHoneybee

data/lib/from_honeybee/program_type.rb

@@ -0,0 +1,124 @@
+# *******************************************************************************
+# 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 '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
+  
+    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)    
+      # create openstudio space type object
+      os_space_type = OpenStudio::Model::SpaceType.new(openstudio_model)
+      os_space_type.setName(@hash[:identifier])
+
+      # assign people 
+      if @hash[:people]
+        people = PeopleAbridged.new(@hash[:people])
+        os_people = people.to_openstudio(openstudio_model)
+        os_people.setSpaceType(os_space_type)
+      end
+
+      # assign lighting
+      if @hash[:lighting]
+        lights = LightingAbridged.new(@hash[:lighting])
+        os_lights = lights.to_openstudio(openstudio_model)
+        os_lights.setSpaceType(os_space_type)
+      end
+
+      # assign electric equipment
+      if @hash[:electric_equipment]
+        electric_equipment = ElectricEquipmentAbridged.new(@hash[:electric_equipment])
+        os_electric_equipment = electric_equipment.to_openstudio(openstudio_model)
+        os_electric_equipment.setSpaceType(os_space_type)
+      end
+
+      # assign gas equipment
+      if @hash[:gas_equipment]
+        gas_equipment = GasEquipmentAbridged.new(@hash[:gas_equipment])
+        os_gas_equipment = gas_equipment.to_openstudio(openstudio_model)
+        os_gas_equipment.setSpaceType(os_space_type)
+      end
+        
+      # assign infiltration
+      if @hash[:infiltration]
+        infiltration = InfiltrationAbridged.new(@hash[:infiltration])
+        os_infiltration = infiltration.to_openstudio(openstudio_model)
+        os_infiltration.setSpaceType(os_space_type)
+      end
+    
+      # assign ventilation
+      if @hash[:ventilation]
+        ventilation = VentilationAbridged.new(@hash[:ventilation])
+        os_ventilation = ventilation.to_openstudio(openstudio_model)
+        os_space_type.setDesignSpecificationOutdoorAir(os_ventilation)
+      end
+
+      # add setpoints from to a global hash that will be used to assign them to rooms
+      if @hash[:setpoint]
+        $programtype_setpoint_hash[@hash[:identifier]] = @hash[:setpoint]
+      end
+
+      os_space_type
+    end
+
+  end #ProgramTypeAbridged 
+end #FromHoneybee
+
+
+

data/lib/from_honeybee/schedule/fixed_interval.rb

@@ -0,0 +1,115 @@
+# *******************************************************************************
+# 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 'from_honeybee/extension'
+require 'from_honeybee/model_object'
+
+module FromHoneybee
+  class ScheduleFixedIntervalAbridged < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+
+      raise "Incorrect model type '#{@type}'" unless @type == 'ScheduleFixedIntervalAbridged'
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:ScheduleFixedIntervalAbridged][:properties]
+    end
+
+    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)
+      os_fi_schedule.setName(@hash[:identifier])
+
+      # assign start date
+      if @hash[:start_date]
+        os_fi_schedule.setStartMonth(@hash[:start_date][0])
+        os_fi_schedule.setStartDay(@hash[:start_date][1])
+      else
+        os_fi_schedule.setStartMonth(defaults[:start_date][:default][0])
+        os_fi_schedule.setStartDay(defaults[:start_date][:default][1])
+      end
+
+      # assign the interpolate value
+      unless @hash[:interpolate].nil?
+        os_fi_schedule.setInterpolatetoTimestep(@hash[:interpolate])
+      else
+        os_fi_schedule.setInterpolatetoTimestep(defaults[:interpolate][:default])
+      end
+
+      # assign the schedule type limit
+      if @hash[:schedule_type_limit]
+        schedule_type_limit = openstudio_model.getScheduleTypeLimitsByName(@hash[:schedule_type_limit])
+        unless schedule_type_limit.empty?
+          schedule_type_limit_object = schedule_type_limit.get
+          os_fi_schedule.setScheduleTypeLimits(schedule_type_limit_object)
+        end
+      end
+
+      # assign the timestep
+      if @hash[:timestep]
+        timestep = @hash[:timestep]
+        interval_length = 60 / timestep
+        os_fi_schedule.setIntervalLength(interval_length)
+      else
+        timestep = defaults[:timestep][:default]
+        interval_length = 60 / timestep
+        os_fi_schedule.setIntervalLength(interval_length)
+      end
+      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] 
+        year_description.setIsLeapYear(true)
+      end
+
+      start_date = year_description.makeDate(@hash[:start_date][0], @hash[:start_date][1])
+
+      values = @hash[:values]
+      timeseries = OpenStudio::TimeSeries.new(start_date, openstudio_interval_length, OpenStudio.createVector(values), '')
+      os_fi_schedule.setTimeSeries(timeseries)
+
+      os_fi_schedule
+    end
+    
+  end #ScheduleFixedIntervalAbridged
+end #FromHoneybee

data/lib/from_honeybee/schedule/ruleset.rb

@@ -0,0 +1,164 @@
+# *******************************************************************************
+# 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 'from_honeybee/model_object'
+
+require 'openstudio'
+
+module FromHoneybee
+  class ScheduleRulesetAbridged < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+
+      raise "Incorrect model type '#{@type}'" unless @type == 'ScheduleRulesetAbridged'
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:ScheduleRulesetAbridged][:properties]
+    end
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getScheduleRulesetByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create openstudio schedule ruleset object
+      os_sch_ruleset = OpenStudio::Model::ScheduleRuleset.new(openstudio_model)
+      os_sch_ruleset.setName(@hash[:identifier])
+
+      # loop through day schedules and create openstudio schedule day object
+      @hash[:day_schedules].each do |day_schedule|
+        day_schedule_new = OpenStudio::Model::ScheduleDay.new(openstudio_model)
+        day_schedule_new.setName(day_schedule[:identifier])
+        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
+      end
+
+      # 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
+          begin
+            os_sch_ruleset.setHolidaySchedule(holiday_schedule_object)  
+          rescue NoMethodError 
+          end
+        end
+      end
+
+      # 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?
+          summer_design_day_object = summer_design_day.get
+          os_sch_ruleset.setSummerDesignDaySchedule(summer_design_day_object)
+        end
+      end
+
+      # assign winter design day schedule
+      if @hash[:winter_designday_schedule]
+        winter_design_day = openstudio_model.getScheduleDayByName(@hash[:winter_designday_schedule])
+        unless winter_design_day.empty?
+          winter_design_day_object = winter_design_day.get
+          os_sch_ruleset.setWinterDesignDaySchedule(winter_design_day_object)
+        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
+      end
+      
+      # assign schedule type limit
+      if @hash[:schedule_type_limit]
+        schedule_type_limit = openstudio_model.getScheduleTypeLimitsByName(@hash[:schedule_type_limit])
+        unless schedule_type_limit.empty?
+          schedule_type_limit_object = schedule_type_limit.get
+          os_sch_ruleset.setScheduleTypeLimits(schedule_type_limit_object)
+        end
+      end
+
+      # assign schedule rules
+      if @hash[:schedule_rules]
+        @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])
+          openstudio_schedule_rule.setApplyTuesday(rule[:apply_tuesday])
+          openstudio_schedule_rule.setApplyWednesday(rule[:apply_wednesday])
+          openstudio_schedule_rule.setApplyThursday(rule[:apply_thursday])
+          openstudio_schedule_rule.setApplyFriday(rule[:apply_friday])
+          openstudio_schedule_rule.setApplySaturday(rule[:apply_saturday])
+          year_description = openstudio_model.getYearDescription
+          start_date = year_description.makeDate(rule[:start_date][0], rule[:start_date][1])         
+          end_date = year_description.makeDate(rule[:end_date][0], rule[:end_date][1])
+          openstudio_schedule_rule.setStartDate(start_date)
+          openstudio_schedule_rule.setEndDate(end_date)
+
+          schedule_rule_day = openstudio_model.getScheduleDayByName(rule[:schedule_day])
+          unless schedule_rule_day.empty?
+            schedule_rule_day_object = schedule_rule_day.get
+
+            values_day = schedule_rule_day_object.values
+            times_day = schedule_rule_day_object.times
+
+            values_day.each_index do |i|
+              openstudio_schedule_rule.daySchedule.addValue(times_day[i], values_day[i])
+            end
+          end
+
+          #set schedule rule index
+          index = @hash[:schedule_rules].find_index(rule)
+          os_sch_ruleset.setScheduleRuleIndex(openstudio_schedule_rule, index)
+        end
+      end
+
+      os_sch_ruleset
+    end
+
+  end #ScheduleRulesetAbridged
+end #FromHoneybee