honeybee-openstudio 1.8.1 → 1.8.2

data/lib/measures/from_honeybee_simulation_parameter/measure.xml

@@ -1,91 +1,91 @@
-<measure>
-  <schema_version>3.0</schema_version>
-  <name>from_honeybee_simulation_parameter</name>
-  <uid>a5f500d5-97ff-4048-a6f4-6b0b0a92d0f0</uid>
-  <version_id>1e4bf088-594a-49b3-89c7-91acc7b10262</version_id>
-  <version_modified>20191221T003153Z</version_modified>
-  <xml_checksum>D8922A73</xml_checksum>
-  <class_name>FromHoneybeeSimulationParameter</class_name>
-  <display_name>From Honeybee Simulation Parameter</display_name>
-  <description>Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.</description>
-  <modeler_description>Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.</modeler_description>
-  <arguments>
-    <argument>
-      <name>simulation_parameter_json</name>
-      <display_name>Path to the Honeybee SimulationParameter 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>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>CD7F5672</checksum>
-    </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>3D2FC3F1</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>52EE8F57</checksum>
-    </file>
-    <file>
-      <filename>from_honeybee_simulation_parameter_test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>F2F0C340</checksum>
-    </file>
-    <file>
-      <filename>simulation_par_detailed.json</filename>
-      <filetype>json</filetype>
-      <usage_type>test</usage_type>
-      <checksum>E2C31DBD</checksum>
-    </file>
-    <file>
-      <filename>simulation_par_simple.json</filename>
-      <filetype>json</filetype>
-      <usage_type>test</usage_type>
-      <checksum>E2C31DBD</checksum>
-    </file>
-  </files>
-</measure>
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>from_honeybee_simulation_parameter</name>
+  <uid>a5f500d5-97ff-4048-a6f4-6b0b0a92d0f0</uid>
+  <version_id>1e4bf088-594a-49b3-89c7-91acc7b10262</version_id>
+  <version_modified>20191221T003153Z</version_modified>
+  <xml_checksum>D8922A73</xml_checksum>
+  <class_name>FromHoneybeeSimulationParameter</class_name>
+  <display_name>From Honeybee Simulation Parameter</display_name>
+  <description>Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.</description>
+  <modeler_description>Add a JSON file of Honeybee Simulationtion Parameters to an OpenStudio Model.</modeler_description>
+  <arguments>
+    <argument>
+      <name>simulation_parameter_json</name>
+      <display_name>Path to the Honeybee SimulationParameter 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>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>CD7F5672</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>3D2FC3F1</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>52EE8F57</checksum>
+    </file>
+    <file>
+      <filename>from_honeybee_simulation_parameter_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>F2F0C340</checksum>
+    </file>
+    <file>
+      <filename>simulation_par_detailed.json</filename>
+      <filetype>json</filetype>
+      <usage_type>test</usage_type>
+      <checksum>E2C31DBD</checksum>
+    </file>
+    <file>
+      <filename>simulation_par_simple.json</filename>
+      <filetype>json</filetype>
+      <usage_type>test</usage_type>
+      <checksum>E2C31DBD</checksum>
+    </file>
+  </files>
+</measure>

data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb

@@ -1,109 +1,109 @@
-# *******************************************************************************
-# 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 FromHoneybeeSimulationParameter_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 = FromHoneybeeSimulationParameter.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
-
-    # save the model to test output directory
-    output_file_path = OpenStudio::Path.new(File.dirname(__FILE__) + "/output/#{test_name}_test_output.osm")
-    model.save(output_file_path, true)
-  end
-
-  def test_simulation_par_simple
-    args = {}
-    args['simulation_parameter_json'] = File.join(File.dirname(__FILE__) + 
-    "/../../../../spec/samples/simulation_parameter/simulation_par_simple.json")
-    apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
-  end
-
-  def test_simulation_par_detailed
-    args = {}
-    args['simulation_parameter_json'] = File.join(File.dirname(__FILE__) +  "/../../../../spec/samples/simulation_parameter/simulation_par_detailed.json")
-    apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
-  end
-
-end
+# *******************************************************************************
+# 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 FromHoneybeeSimulationParameter_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 = FromHoneybeeSimulationParameter.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
+
+    # save the model to test output directory
+    output_file_path = OpenStudio::Path.new(File.dirname(__FILE__) + "/output/#{test_name}_test_output.osm")
+    model.save(output_file_path, true)
+  end
+
+  def test_simulation_par_simple
+    args = {}
+    args['simulation_parameter_json'] = File.join(File.dirname(__FILE__) + 
+    "/../../../../spec/samples/simulation_parameter/simulation_par_simple.json")
+    apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
+  end
+
+  def test_simulation_par_detailed
+    args = {}
+    args['simulation_parameter_json'] = File.join(File.dirname(__FILE__) +  "/../../../../spec/samples/simulation_parameter/simulation_par_detailed.json")
+    apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.2
 platform: ruby
 authors:
 - Tanushree Charan
@@ -236,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Gem for translating between Honeybee JSON and OpenStudio Model.