honeybee-openstudio 2.6.9 → 2.7.0

data/lib/from_openstudio/model_object.rb

@@ -0,0 +1,43 @@
+# *******************************************************************************
+# 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.
+# *******************************************************************************
+
+module Honeybee
+  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.
+
+    # 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_openstudio/simulation/design_day.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_object'
+
+module Honeybee
+  class DesignDay
+
+    def self.from_design_day(design_day)
+      hash = {}
+      hash[:type] = 'DesignDay'
+      hash[:name] = design_day.nameString
+      hash[:day_type] = day_type_from_design_day(design_day)
+      hash[:dry_bulb_condition] = dry_bulb_condition_from_design_day(design_day)
+      hash[:humidity_condition] = humidity_condition_from_design_day(design_day)
+      hash[:wind_condition] = wind_condition_from_design_day(design_day)
+      hash[:sky_condition] = sky_condition_from_design_day(design_day)
+
+      hash
+    end
+
+    def self.day_type_from_design_day(design_day)
+      design_day.dayType
+    end
+
+    def self.dry_bulb_condition_from_design_day(design_day)
+      hash = {}
+      hash[:type] = 'DryBulbCondition'
+      hash[:dry_bulb_max] = design_day.maximumDryBulbTemperature
+      hash[:dry_bulb_range] = design_day.dailyDryBulbTemperatureRange
+      hash
+    end
+
+    def self.humidity_type_from_design_day(design_day)
+      humidity_type = design_day.humidityIndicatingType
+      allowed_types = ['WetBulb', 'Dewpoint', 'HumidityRatio', 'Enthalpy']
+      if !allowed_types.any?{ |s| s.casecmp(humidity_type)==0 }
+        raise "'#{humidity_type}' is not an allowed humidity type"
+      end
+      humidity_type.gsub('WetBulb', 'Wetbulb')
+    end
+
+    def self.humidity_condition_from_design_day(design_day)
+      hash = {}
+      hash[:type] = 'HumidityCondition'
+      hash[:humidity_type] = humidity_type_from_design_day(design_day)
+      hash[:humidity_value] = design_day.humidityIndicatingConditionsAtMaximumDryBulb
+      hash[:barometric_pressure] = design_day.barometricPressure
+      hash[:rain] = design_day.rainIndicator
+      hash[:snow_on_ground] = design_day.snowIndicator
+      hash
+    end
+
+    def self.wind_condition_from_design_day(design_day)
+      hash = {}
+      hash[:type] = 'WindCondition'
+      hash[:wind_speed] = design_day.windSpeed
+      hash[:wind_direction] = design_day.windDirection
+      hash
+    end
+
+    def self.ashrae_clear_sky_from_design_day(design_day)
+      hash = {}
+      hash[:type] = 'ASHRAEClearSky'
+      hash[:date] = [design_day.month, design_day.dayOfMonth]
+      hash[:clearness] = design_day.skyClearness
+      hash[:daylight_savings] = design_day.daylightSavingTimeIndicator
+      hash
+    end
+
+    def self.ashrae_tau_from_design_day(design_day)
+      hash = {}
+      hash[:type] = 'ASHRAETau'
+      hash[:date] = [design_day.month, design_day.dayOfMonth]
+      hash[:tau_b] = design_day.ashraeTaub
+      hash[:tau_d] = design_day.ashraeTaud
+      hash[:daylight_savings] = design_day.daylightSavingTimeIndicator
+      hash
+    end
+
+    def self.sky_condition_from_design_day(design_day)
+      solar_model_indicator = design_day.solarModelIndicator
+      allowed_types = ['ASHRAEClearSky', 'ASHRAETau', 'ASHRAETau2017']
+      if !allowed_types.any?{ |s| s.casecmp(solar_model_indicator)==0 }
+        raise "'#{solar_model_indicator}' is not an allowed solar model indicator"
+      end
+      if solar_model_indicator == 'ASHRAEClearSky'
+        return ashrae_clear_sky_from_design_day(design_day)
+      else
+        return ashrae_tau_from_design_day(design_day)
+      end
+    end
+
+  end # DesignDay
+end # Honeybee

data/lib/from_openstudio/simulation/parameter_model.rb

@@ -0,0 +1,93 @@
+# *******************************************************************************
+# 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/simulation/parameter_model'
+
+require 'from_openstudio/simulation/design_day'
+
+module Honeybee
+
+  class SimulationParameter
+
+    # Create Ladybug SimulationParameter JSON from OpenStudio Model
+    def self.translate_from_openstudio(openstudio_model)
+      hash = {}
+      hash[:type] = 'SimulationParameter'
+
+      hash[:output] = SimulationOutput.from_model(openstudio_model)
+      hash[:sizing_parameter] = sizing_parameter_from_model(openstudio_model)
+
+      SimulationParameter.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.sizing_parameter_from_model(openstudio_model)
+      hash = {}
+      hash[:type] = 'SizingParameter'
+      hash[:design_days] = []
+      openstudio_model.getDesignDays.each do |design_day|
+        begin
+          hash[:design_days] << DesignDay.from_design_day(design_day)
+        rescue
+        end
+      end
+
+      sizing_parameters = openstudio_model.getSizingParameters
+      hash[:heating_factor] = sizing_parameters.heatingSizingFactor
+      hash[:cooling_factor] = sizing_parameters.coolingSizingFactor
+      hash
+    end
+
+  end #SimulationParameter
+end #Honeybee

data/lib/from_openstudio/simulation/simulation_output.rb

@@ -0,0 +1,67 @@
+# *******************************************************************************
+# 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 SimulationOutput
+
+    def self.from_model(openstudio_model)
+      hash = {}
+      hash[:type] = 'SimulationOutput'
+      hash[:reporting_frequency] = 'Hourly'
+      hash[:include_sqlite] = true
+      hash[:include_html] = true
+      hash[:outputs] = outputs_from_model(openstudio_model)
+      hash[:summary_reports] = summary_reports_from_model(openstudio_model)
+
+      hash
+    end
+
+    def self.outputs_from_model(openstudio_model)
+      result = []
+      openstudio_model.getOutputVariables.each do |output|
+        result << output.variableName
+      end
+      result
+    end
+
+    def self.summary_reports_from_model(openstudio_model)
+      result = []
+      summary_reports = openstudio_model.getOutputTableSummaryReports
+      summary_reports.summaryReports.each do |summary_report|
+        result << summary_report
+      end
+      result
+    end
+
+  end # SimulationOutput
+end # Honeybee

data/lib/{from_honeybee.rb → honeybee.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:
 #
@@ -30,57 +30,64 @@
 # *******************************************************************************
 
 # import the core objects from which everything inherits
-require 'from_honeybee/extension'
-require 'from_honeybee/model_object'
+require 'honeybee/extension'
+require 'honeybee/model_object'
 
 # import the compound objects that house the other objects
-require 'from_honeybee/model'
-require 'from_honeybee/construction_set'
-require 'from_honeybee/program_type'
+require 'honeybee/model'
+require 'honeybee/construction_set'
+require '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'
+require 'honeybee/geometry/shade'
+require 'honeybee/geometry/door'
+require 'honeybee/geometry/aperture'
+require 'honeybee/geometry/face'
+require 'honeybee/geometry/room'
 
 # import the HVAC objects
-require 'from_honeybee/hvac/ideal_air'
+require 'honeybee/hvac/ideal_air'
+require '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'
+require 'honeybee/construction/opaque'
+require 'honeybee/construction/window'
+require 'honeybee/construction/windowshade'
+require 'honeybee/construction/shade'
+require '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'
+require 'honeybee/material/opaque'
+require 'honeybee/material/opaque_no_mass'
+require 'honeybee/material/window_gas'
+require 'honeybee/material/window_gas_mixture'
+require 'honeybee/material/window_gas_custom'
+require 'honeybee/material/window_blind'
+require 'honeybee/material/window_glazing'
+require 'honeybee/material/window_shade'
+require 'honeybee/material/window_simpleglazsys'
 
 # import the load objects
-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 'honeybee/load/people'
+require 'honeybee/load/lighting'
+require 'honeybee/load/electric_equipment'
+require 'honeybee/load/gas_equipment'
+require 'honeybee/load/infiltration'
+require 'honeybee/load/ventilation'
+require 'honeybee/load/setpoint_thermostat'
+require 'honeybee/load/setpoint_humidistat'
 
 # import the schedule objects
-require 'from_honeybee/schedule/type_limit'
-require 'from_honeybee/schedule/fixed_interval'
-require 'from_honeybee/schedule/ruleset'
+require 'honeybee/schedule/type_limit'
+require 'honeybee/schedule/fixed_interval'
+require 'honeybee/schedule/ruleset'
+
+# import the ventilation objects
+require 'honeybee/ventcool/control'
+require 'honeybee/ventcool/opening'
+require 'honeybee/ventcool/simulation'
 
 # import the simulation objects
-require 'from_honeybee/simulation/extension'
-require 'from_honeybee/simulation/parameter'
+require 'honeybee/simulation/design_day'
+require 'honeybee/simulation/parameter_model'
+require 'honeybee/simulation/simulation_output'

data/lib/{from_honeybee → honeybee}/_defaults/simulation-parameter.json

@@ -515,6 +515,7 @@
           "Wednesday",
           "Thursday",
           "Friday",
+          "Saturday",
           "Holiday",
           "CustomDay1",
           "CustomDay2"