honeybee-openstudio 2.12.1 → 2.16.0

data/lib/from_openstudio/material/window_glazing.rb

@@ -0,0 +1,77 @@
+# *******************************************************************************
+# 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/material/window_glazing'
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class EnergyWindowMaterialGlazing
+
+    def self.from_material(material)
+        # create an empty hash
+        hash = {}
+        hash[:type] = 'EnergyWindowMaterialGlazing'
+        # set hash values from OpenStudio Object
+        hash[:identifier] = material.nameString
+        hash[:thickness] = material.thickness
+        hash[:solar_transmittance] = material.solarTransmittance
+        # check if boost optional object is empty
+        unless material.frontSideSolarReflectanceatNormalIncidence.empty?
+            hash[:solar_reflectance] = material.frontSideSolarReflectanceatNormalIncidence.get
+        end
+        # check if boost optional object is empty
+        unless material.backSideSolarReflectanceatNormalIncidence.empty?
+            hash[:solar_reflectance_back] = material.backSideSolarReflectanceatNormalIncidence.get
+        end
+        # check if boost optional object is empty
+        unless material.visibleTransmittanceatNormalIncidence.empty?
+            hash[:visible_transmittance] = material.visibleTransmittanceatNormalIncidence.get
+        end
+        # check if boost optional object is empty
+        unless material.frontSideVisibleReflectanceatNormalIncidence.empty?
+            hash[:visible_reflectance] = material.frontSideVisibleReflectanceatNormalIncidence.get
+        end
+        # check if boost optional object is empty
+        unless material.backSideVisibleReflectanceatNormalIncidence.empty?
+            hash[:visible_reflectance_back] = material.backSideVisibleReflectanceatNormalIncidence
+        end
+        hash[:infrared_transmittance] = material.infraredTransmittance
+        hash[:emissivity] = material.frontSideInfraredHemisphericalEmissivity
+        hash[:emissivity_back] = material.backSideInfraredHemisphericalEmissivity
+        hash[:conductivity] = material.thermalConductivity
+        hash[:dirt_correction] = material.dirtCorrectionFactorforSolarandVisibleTransmittance
+        hash[:solar_diffusing] = material.solarDiffusing
+
+        hash
+    end
+
+  end # EnergyWindowMaterialGlazing
+end # Honeybee

data/lib/from_openstudio/material/window_simpleglazsys.rb

@@ -0,0 +1,55 @@
+# *******************************************************************************
+# 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/material/window_simpleglazsys'
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class EnergyWindowMaterialSimpleGlazSys < ModelObject
+
+    def self.from_material(material)
+        # create an empty hash
+        hash = {}
+        hash[:type] = 'EnergyWindowMaterialSimpleGlazSys'
+        # set hash values from OpenStudio Object
+        hash[:identifier] = material.nameString
+        hash[:u_factor] = material.uFactor
+        hash[:shgc] = material.solarHeatGainCoefficient
+        # check if boost optional object is empty
+        unless material.visibleTransmittance.empty?
+          hash[:vt] = material.visibleTransmittance.get
+        end
+
+        hash
+    end
+
+  end # EnergyWindowMaterialSimpleGlazSys
+end # Honeybee

data/lib/from_openstudio/model.rb

@@ -33,6 +33,14 @@ require 'honeybee/model'
 
 require 'from_openstudio/geometry/room'
 require 'from_openstudio/geometry/shade'
+require 'from_openstudio/material/opaque'
+require 'from_openstudio/material/opaque_no_mass'
+require 'from_openstudio/material/window_simpleglazsys'
+require 'from_openstudio/material/window_glazing'
+require 'from_openstudio/material/window_blind'
+require 'from_openstudio/material/window_gas'
+require 'from_openstudio/material/window_gas_custom'
+require 'from_openstudio/material/window_gas_mixture'
 
 require 'openstudio'
 
@@ -119,5 +127,48 @@ module Honeybee
       result
     end
 
+    # Create HB Material from OpenStudio Materials
+    def self.materials_from_model(openstudio_model)
+      result = []
+
+      # TODO: Loop through all materials and add puts statement for unsupported materials.
+      
+      # Create HB EnergyMaterial from OpenStudio Material
+      openstudio_model.getStandardOpaqueMaterials.each do |material|
+        result << EnergyMaterial.from_material(material)
+      end
+      # Create HB EnergyMaterialNoMass from OpenStudio Material
+      openstudio_model.getMasslessOpaqueMaterials.each do |material|
+        result << EnergyMaterialNoMass.from_material(material)
+      end
+      # Create HB WindowMaterialSimpleGlazSys from OpenStudio Material
+      openstudio_model.getSimpleGlazings.each do |material|
+        result << EnergyWindowMaterialSimpleGlazSys.from_material(material)
+      end
+      # Create HB EnergyWindowMaterialGlazing from OpenStudio Material
+      openstudio_model.getStandardGlazings.each do |material|
+        result << EnergyWindowMaterialGlazing.from_material(material)
+      end
+      # Create HB EnergyWindowMaterialBlind from OpenStudio Material
+      openstudio_model.getBlinds.each do |material|
+        result << EnergyWindowMaterialBlind.from_material(material)
+      end
+      openstudio_model.getGass.each do |material|
+        # Create HB WindowGasCustom from OpenStudio Material
+        if material.gasType == 'Custom'
+          result << EnergyWindowMaterialGasCustom.from_material(material)
+        else
+        # Create HB WindowGas from OpenStudio Material
+          result << EnergyWindowMaterialGas.from_material(material)
+        end
+      end
+      # Create HB EnergyWindowMaterialGasMixture from OpenStudio Material
+      openstudio_model.getGasMixtures.each do |material|
+        result << EnergyWindowMaterialGasMixture.from_material(material)
+      end
+
+      result
+    end
+
   end # Model
 end # Honeybee

data/lib/measures/from_gbxml_model/LICENSE.md

@@ -0,0 +1,23 @@
+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.

data/lib/measures/from_gbxml_model/README.md

@@ -0,0 +1,32 @@
+
+
+###### (Automatically generated documentation)
+
+# From gbXML Model
+
+## Description
+Translate a gbXML model into a JSON file of a Honeybee Model.
+
+## Modeler Description
+Translate a gbXML model into a JSON file of a Honeybee Model.
+
+## Measure Type
+ModelMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+### Path to the gbXML Model file
+
+**Name:** gbxml_model,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+
+

data/lib/measures/from_gbxml_model/measure.rb

@@ -0,0 +1,114 @@
+# *******************************************************************************
+# 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.
+# *******************************************************************************
+
+# see the URL below for information on how to write OpenStudio measures
+# http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/
+
+require 'from_openstudio'
+
+# start the measure
+class FromGbxmlModel < OpenStudio::Measure::ModelMeasure
+  # human readable name
+  def name
+    return "From Gbxml Model"
+  end
+
+  # human readable description
+  def description
+    return "Translate a gbXML into a JSON file of a Honeybee Model."
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    return "Translate a gbXML into a JSON file of a Honeybee Model."
+  end
+
+  # define the arguments that the user will input
+  def arguments(model)
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    # Make an argument for the OpenStudio model
+    gbxml_model = OpenStudio::Measure::OSArgument.makeStringArgument('gbxml_model', true)
+    gbxml_model.setDisplayName('Path to the gbXML Model')
+    args << gbxml_model
+
+    # Make an argument for the output file path
+    output_file_path = OpenStudio::Measure::OSArgument.makeStringArgument('output_file_path', false)
+    output_file_path.setDisplayName('Output file path')
+    output_file_path.setDescription('If set, the output Honeybee JSON file will be exported to this path. Othervise The file will be exported to the same path as the gbXML model.')
+    output_file_path.setDefaultValue('')
+    args << output_file_path
+
+    return args
+  end
+
+  # define what happens when the measure is run
+  def run(model, runner, user_arguments)
+    super(model, runner, user_arguments)
+    STDOUT.flush
+    if !runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+
+    gbxml_model = runner.getStringArgumentValue('gbxml_model', user_arguments)
+
+    gbxml_model_path, gbxml_model_name = File.split(gbxml_model)
+    honeybee_model_name = gbxml_model_name.split('.')[0] + '.hbjson'
+
+    if !File.exist?(gbxml_model)
+      runner.registerError("Cannot find file '#{gbxml_model}'")
+      return false
+    end
+
+    honeybee_model = Honeybee::Model.translate_from_gbxml_file(gbxml_model)
+    honeybee_hash = honeybee_model.hash
+
+    output_file_path = runner.getStringArgumentValue('output_file_path', user_arguments)
+    
+    if output_file_path && !output_file_path.empty?
+      unless File.exist?(output_file_path)
+        output_folder = File.split(output_file_path)[0]
+        FileUtils.mkdir_p(output_folder)
+      end
+    else
+      output_file_path = File.join(gbxml_model_path, honeybee_model_name)
+    end
+
+    File.open(output_file_path, 'w') do |f|
+      f.puts JSON::pretty_generate(honeybee_hash)
+    end
+
+    return true
+  end
+end
+
+# register the measure to be used by the application
+FromGbxmlModel.new.registerWithApplication

data/lib/measures/from_gbxml_model/measure.xml

@@ -0,0 +1,131 @@
+<?xml version="1.0"?>
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>from_gbxml_model</name>
+  <uid>e4b3a388-3468-4962-a12e-e2e02bacb0a2</uid>
+  <version_id>0261fa70-1322-43ce-ae24-e6e65eb98f03</version_id>
+  <version_modified>20210428T160059Z</version_modified>
+  <xml_checksum>6BA95EF6</xml_checksum>
+  <class_name>FromGbxmlModel</class_name>
+  <display_name>From Gbxml Model</display_name>
+  <description>Translate a gbXML into a JSON file of a Honeybee Model.</description>
+  <modeler_description>Translate a gbXML into a JSON file of a Honeybee Model.</modeler_description>
+  <arguments>
+    <argument>
+      <name>model_json</name>
+      <display_name>Path to the Honeybee Model JSON file</display_name>
+      <description></description>
+      <type>String</type>
+      <units></units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value></default_value>
+      <min_value></min_value>
+      <max_value></max_value>
+    </argument>
+  </arguments>
+  <outputs />
+  <provenances />
+  <tags>
+    <tag>Whole Building.Space Types</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Apply Measure Now</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>OpenStudio Application</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Parametric Analysis Tool</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Apply Measure Now</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>OpenStudio Application</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Parametric Analysis Tool</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Apply Measure Now</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>OpenStudio Application</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Parametric Analysis Tool</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ModelMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Apply Measure Now</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>OpenStudio Application</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Parametric Analysis Tool</value>
+      <datatype>string</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>1E0EDDB0</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>782C496D</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.0.0</identifier>
+        <min_compatible>2.0.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>D5D8CB66</checksum>
+    </file>
+    <file>
+      <filename>from_gbxml_model_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>AE86B654</checksum>
+    </file>
+  </files>
+</measure>
+<error>cannot load such file -- from_openstudio</error>