honeybee-openstudio 2.14.0 → 2.16.3

data/lib/measures/from_honeybee_model_to_gbxml/tests/from_honeybee_model_to_gbxml_test.rb

@@ -0,0 +1,105 @@
+# *******************************************************************************
+# 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'
+require 'openstudio/ruleset/ShowRunnerOutput'
+require 'minitest/autorun'
+require_relative '../measure.rb'
+require 'fileutils'
+
+class FromHoneybeeModelToGbxml_Test < Minitest::Test
+  # method to apply arguments, run measure, and assert results (only populate args hash with non-default argument values)
+  def apply_measure_to_model(test_name, args, model_name = nil, result_value = 'Success', warnings_count = 0, info_count = nil)
+    # create an instance of the measure
+    measure = FromHoneybeeModelToGbxml.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    if model_name.nil?
+      # make an empty model
+      model = OpenStudio::Model::Model.new
+    else
+      # load the test model
+      translator = OpenStudio::OSVersion::VersionTranslator.new
+      path = OpenStudio::Path.new(File.dirname(__FILE__) + '/' + model_name)
+      model = translator.loadModel(path)
+      assert(!model.empty?)
+      model = model.get
+    end
+
+    # get arguments
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    # populate argument with specified hash value if specified
+    arguments.each do |arg|
+      temp_arg_var = arg.clone
+      if args.key?(arg.name)
+        assert(temp_arg_var.setValue(args[arg.name]), "could not set #{arg.name} to #{args[arg.name]}.")
+      end
+      argument_map[arg.name] = temp_arg_var
+    end
+
+    # run the measure
+    measure.run(model, runner, argument_map)
+    result = runner.result
+
+    # show the output
+    puts "measure results for #{test_name}"
+    show_output(result)
+
+    # assert that it ran correctly
+    if result_value.nil? then result_value = 'Success' end
+    assert_equal(result_value, result.value.valueName)
+
+    # check count of warning and info messages
+    unless info_count.nil? then assert(result.info.size == info_count) end
+    unless warnings_count.nil? then assert(result.warnings.size == warnings_count, "warning count (#{result.warnings.size}) did not match expectation (#{warnings_count})") end
+
+    # if 'Fail' passed in make sure at least one error message (while not typical there may be more than one message)
+    if result_value == 'Fail' then assert(result.errors.size >= 1) end
+
+  end
+
+  def test_shoe_box
+    args = {}
+    args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_energy_shoe_box.json")
+    apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
+  end
+
+  def test_office_floor
+    args = {}
+    args['model_json'] = File.join(File.dirname(__FILE__) + "/../../../../spec/samples/model/model_complete_office_floor.json")
+    apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
+  end
+
+end

data/lib/measures/from_idf_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_idf_model/README.md

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

data/lib/measures/from_idf_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 FromIDFModel < OpenStudio::Measure::ModelMeasure
+  # human readable name
+  def name
+    return "From IDF Model"
+  end
+
+  # human readable description
+  def description
+    return "Translate an IDF into a JSON file of a Honeybee Model."
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    return "Translate an IDF 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
+    idf_model = OpenStudio::Measure::OSArgument.makeStringArgument('idf_model', true)
+    idf_model.setDisplayName('Path to the IDF Model')
+    args << idf_model
+
+    # Make an argument for the output file path
+    output_file_path = OpenStudio::Measure::OSArgument.makeStringArgument('output_file_path', true)
+    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 IDF 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
+
+    idf_model = runner.getStringArgumentValue('idf_model', user_arguments)
+
+    idf_model_path, idf_model_name = File.split(idf_model)
+    honeybee_model_name = idf_model_name.split('.')[0] + '.hbjson'
+
+    if !File.exist?(idf_model)
+      runner.registerError("Cannot find file '#{idf_model}'")
+      return false
+    end
+
+    honeybee_model = Honeybee::Model.translate_from_idf_file(idf_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(idf_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
+FromIDFModel.new.registerWithApplication

data/lib/measures/from_idf_model/measure.xml

@@ -0,0 +1,110 @@
+<measure>
+  <schema_version>3.0</schema_version>
+  <error>cannot load such file -- from_openstudio</error>
+  <name>from_idf_model</name>
+  <uid>6289a4f0-a0b5-4c6e-901c-803bbfa86285</uid>
+  <version_id>83bb447b-e314-450e-ac1c-3907a7ac9857</version_id>
+  <version_modified>20210428T160244Z</version_modified>
+  <xml_checksum>9339BE01</xml_checksum>
+  <class_name>FromIDFModel</class_name>
+  <display_name>From IDF Model</display_name>
+  <description>Translate an IDF into a JSON file of a Honeybee Model.</description>
+  <modeler_description>Translate an IDF 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>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+    </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>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>6ED73120</checksum>
+    </file>
+    <file>
+      <filename>from_idf_model_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>8D19788D</checksum>
+    </file>
+  </files>
+</measure>

data/lib/measures/from_idf_model/tests/from_idf_model_test.rb

@@ -0,0 +1,107 @@
+# *******************************************************************************
+# 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'
+require 'openstudio/ruleset/ShowRunnerOutput'
+require 'minitest/autorun'
+require_relative '../measure.rb'
+require 'fileutils'
+
+class FromIDFModel_Test < Minitest::Test
+  # method to apply arguments, run measure, and assert results (only populate args hash with non-default argument values)
+  def apply_measure_to_model(test_name, args, model_name = nil, result_value = 'Success', warnings_count = 0, info_count = nil)
+    # create an instance of the measure
+    measure = FromIDFModel.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    if model_name.nil?
+      # make an empty model
+      model = OpenStudio::Model::Model.new
+    else
+      # load the test model
+      translator = OpenStudio::OSVersion::VersionTranslator.new
+      path = OpenStudio::Path.new(File.dirname(__FILE__) + '/' + model_name)
+      model = translator.loadModel(path)
+      assert(!model.empty?)
+      model = model.get
+    end
+
+    # get arguments
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    # populate argument with specified hash value if specified
+    arguments.each do |arg|
+      temp_arg_var = arg.clone
+      if args.key?(arg.name)
+        assert(temp_arg_var.setValue(args[arg.name]), "could not set #{arg.name} to #{args[arg.name]}.")
+      end
+      argument_map[arg.name] = temp_arg_var
+    end
+
+    # run the measure
+    measure.run(model, runner, argument_map)
+    result = runner.result
+
+    puts "this is measure #{measure.run(model, runner, argument_map)}"
+    # show the output
+    puts "measure results for #{test_name}"
+    show_output(result)
+
+    # assert that it ran correctly
+    if result_value.nil? then result_value = 'Success' end
+    assert_equal(result_value, result.value.valueName)
+
+    # check count of warning and info messages
+    unless info_count.nil? then assert(result.info.size == info_count) end
+    unless warnings_count.nil? then assert(result.warnings.size == warnings_count, "warning count (#{result.warnings.size}) did not match expectation (#{warnings_count})") end
+
+    # if 'Fail' passed in make sure at least one error message (while not typical there may be more than one message)
+    if result_value == 'Fail' then assert(result.errors.size >= 1) end
+
+  end
+
+  def test_example_model_with_output_path
+    args = {}
+    args['idf_model'] = File.join(File.dirname(__FILE__) + '/../../../../spec/samples/idf/5ZoneAirCooled.idf')
+    args['output_file_path'] = File.join(File.dirname(__FILE__) + '/output/5ZoneAirCooled.hbjson')
+    apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
+  end
+
+  def test_example_model_without_output_path
+    args = {}
+    args['idf_model'] = File.join(File.dirname(__FILE__) + '/../../../../spec/samples/idf/5ZoneAirCooled.idf')
+    apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
+  end
+
+end