tbd 3.0.0

data/lib/measures/tbd/resources/version.rb

@@ -0,0 +1,3 @@
+module Topolys
+  VERSION = "0.6.0"
+end

data/lib/measures/tbd/tests/tbd_full_PSI.json

@@ -0,0 +1,17 @@
+{
+  "description": "TBD JSON example - full PSI-only",
+  "schema": "https://github.com/rd2/tbd/blob/master/tbd.schema.json",
+  "psis": [
+    {
+      "id": "OK",
+      "rimjoist": 0.700,
+      "parapet": 0.700,
+      "fenestration": 0.700,
+      "corner": 0.700,
+      "balcony": 1.000,
+      "party": 0.700,
+      "party": 0.800,
+      "grade": 0.700
+    }
+  ]
+}

data/lib/measures/tbd/tests/tbd_tests.rb

@@ -0,0 +1,222 @@
+# MIT License
+#
+# Copyright (c) 2020-2022 Denis Bourgeois & Dan Macumber
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "openstudio"
+require "openstudio/measure/ShowRunnerOutput"
+require "minitest/autorun"
+require "fileutils"
+
+require_relative "../measure.rb"
+
+
+class TBDTest < Minitest::Test
+  # def setup
+  # end
+
+  # def teardown
+  # end
+
+  def test_number_of_arguments_and_argument_names
+    # create an instance of the measure
+    measure = TBDMeasure.new
+    # make an empty model
+    model = OpenStudio::Model::Model.new
+
+    # get arguments and test that they are what we are expecting
+    arguments = measure.arguments(model)
+    assert_equal(14, arguments.size)
+  end
+
+  def test_no_load_tbd_json
+    # create an instance of the measure
+    measure = TBDMeasure.new
+
+    # Output dirs
+    seed_dir = File.join(__dir__, 'output/no_load_tbd_json/')
+    FileUtils.mkdir_p(seed_dir)
+    seed_path = File.join(seed_dir, 'in.osm')
+
+    # create runner with empty OSW
+    osw = OpenStudio::WorkflowJSON.new
+    osw.setSeedFile(seed_path)
+    runner = OpenStudio::Measure::OSRunner.new(osw)
+
+    # create example test model
+    model = OpenStudio::Model::exampleModel
+    model.save(seed_path, true)
+
+    # get arguments
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    # Create hash of argument values. If the argument has a default that you
+    # want to use, you don't need it in the hash.
+    args_hash                   = {}
+    args_hash["option"        ] = "efficient (BETBG)"
+    args_hash["write_tbd_json"] = true
+    args_hash["gen_UA_report" ] = true
+    args_hash["wall_option"   ] = "ALL wall constructions"
+    args_hash["wall_ut"       ] = 0.5
+    # using defaults values from measure.rb for other arguments
+
+    # populate argument with specified hash value if specified
+    arguments.each do |arg|
+      temp_arg_var = arg.clone
+      gotit = args_hash.key?(arg.name)
+      assert(temp_arg_var.setValue(args_hash[arg.name])) if gotit
+      argument_map[arg.name] = temp_arg_var
+    end
+
+    # run the measure
+    Dir.chdir(seed_dir)
+    measure.run(model, runner, argument_map)
+    result = runner.result
+
+    # show the output
+    show_output(result)
+
+    # assert that it ran correctly
+    assert_equal('Success', result.value.valueName)
+    assert(result.warnings.empty?)
+
+    # save the model to test output directory
+    #output_file_path = "#{File.dirname(__FILE__)}//output/test_output.osm"
+    #model.save(output_file_path, true)
+  end
+
+  def test_load_tbd_json
+    # create an instance of the measure
+    measure = TBDMeasure.new
+
+    # Output dirs
+    seed_dir = File.join(__dir__, "output/load_tbd_json/")
+    FileUtils.mkdir_p(seed_dir)
+    seed_path = File.join(seed_dir, "in.osm")
+
+    # create runner with empty OSW
+    osw = OpenStudio::WorkflowJSON.new
+    osw.setSeedFile(seed_path)
+    runner = OpenStudio::Measure::OSRunner.new(osw)
+
+    # create example test model
+    model = OpenStudio::Model::exampleModel
+    model.save(seed_path, true)
+
+    # copy tdb.json next to seed
+    origin_pth = File.join(__dir__, "tbd_full_PSI.json")
+    target_pth = File.join(seed_dir, "tbd.json")
+    FileUtils.cp(origin_pth, target_pth)
+
+    # get arguments
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    # Create hash of argument values. If the argument has a default that you
+    # want to use, you don't need it in the hash.
+    args_hash = {"load_tbd_json" => true}
+    # using defaults values from measure.rb for other arguments
+
+    # populate argument with specified hash value if specified
+    arguments.each do |arg|
+      temp_arg_var = arg.clone
+      if args_hash.key?(arg.name)
+        assert(temp_arg_var.setValue(args_hash[arg.name]))
+      end
+      argument_map[arg.name] = temp_arg_var
+    end
+
+    # run the measure
+    Dir.chdir(seed_dir)
+    measure.run(model, runner, argument_map)
+    result = runner.result
+
+    # show the output
+    show_output(result)
+
+    # assert that it ran correctly
+    assert_equal('Success', result.value.valueName)
+    assert(result.warnings.empty?)
+
+    # save the model to test output directory
+    #output_file_path = "#{File.dirname(__FILE__)}//output/test_output.osm"
+    #model.save(output_file_path, true)
+  end
+
+  def test_load_tbd_json_error
+    # create an instance of the measure
+    measure = TBDMeasure.new
+
+    # Output dirs
+    seed_dir = File.join(__dir__, "output/load_tbd_json_error/")
+    FileUtils.mkdir_p(seed_dir)
+    seed_path = File.join(seed_dir, "in.osm")
+
+    # create runner with empty OSW
+    osw = OpenStudio::WorkflowJSON.new
+    osw.setSeedFile(seed_path)
+    runner = OpenStudio::Measure::OSRunner.new(osw)
+
+    # create example test model
+    model = OpenStudio::Model::exampleModel
+    model.save(seed_path, true)
+
+    # do not copy tdb.json next to seed
+
+    # get arguments
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    # Create hash of argument values. If the argument has a default that you
+    # want to use, you don't need it in the hash.
+    args_hash = {"load_tbd_json" => true}
+    # using defaults values from measure.rb for other arguments
+
+    # populate argument with specified hash value if specified
+    arguments.each do |arg|
+      temp_arg_var = arg.clone
+      if args_hash.key?(arg.name)
+        assert(temp_arg_var.setValue(args_hash[arg.name]))
+      end
+      argument_map[arg.name] = temp_arg_var
+    end
+
+    # run the measure
+    Dir.chdir(seed_dir)
+    measure.run(model, runner, argument_map)
+    result = runner.result
+
+    # show the output
+    show_output(result)
+
+    # assert that it ran correctly
+    assert_equal('Fail', result.value.valueName)
+    assert(result.errors.size == 1)
+    assert(result.warnings.size == 1)
+    puts result.warnings[0].logMessage
+    log_message = "Can't find 'tbd.json' - simulation halted"
+    assert(result.warnings[0].logMessage == log_message)
+
+    # save the model to test output directory
+    #output_file_path = "#{File.dirname(__FILE__)}//output/test_output.osm"
+    #model.save(output_file_path, true)
+  end
+end