openstudio-load-flexibility-measures 0.6.0 → 0.7.0

data/lib/measures/add_packaged_ice_storage/tests/add_packaged_ice_storage_test.rb

@@ -1,36 +1,6 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2022, Alliance for Sustainable Energy, LLC.
-# 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.
-#
-# (4) Other than as required in clauses (1) and (2), distributions in any form
-# of modifications or other derivative works may not use the "OpenStudio"
-# trademark, "OS", "os", or any other confusingly similar designation without
-# specific prior written permission from Alliance for Sustainable Energy, LLC.
-#
-# 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.
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
 # *******************************************************************************
 
 require 'openstudio'
@@ -46,6 +16,107 @@ class AddPackagedIceStorageTest < MiniTest::Test
   # def teardown
   # end
 
+  # Runs an annual simulation of IDF
+  #
+  # code based on model_run_simulation_and_log_errors from OpenStudio Standards
+  # Maybe update method above to optionally take IDF instead of OSM or add another method
+  #
+  # @param IDF OpenStudio workspace IDF object
+  # @param run_dir [String] file path location for the annual run, defaults to 'Run' in the current directory
+  # @return [Bool] returns true if successful, false if not
+  def model_run_simulation_and_log_errors(workspace, run_dir = "#{Dir.pwd}/Run")
+    # Make the directory if it doesn't exist
+    unless Dir.exist?(run_dir)
+      FileUtils.mkdir_p(run_dir)
+    end
+
+    # Save workspace IDF
+    idf_name = 'in.idf'
+    OpenStudio.logFree(OpenStudio::Debug, 'openstudio.model.Model', "Starting simulation here: #{run_dir}.")
+    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "Running simulation #{run_dir}.")
+    idf_path = OpenStudio::Path.new("#{run_dir}/#{idf_name}")
+    workspace.save(idf_path, true)
+
+    # Set up the simulation
+    # Find the weather file
+    epw_path = OpenStudio::Path.new("#{File.dirname(__FILE__)}/USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw")
+
+    sql_path = nil
+
+    OpenStudio.logFree(OpenStudio::Debug, 'openstudio.model.Model', 'Running with RunManager.')
+
+    # Find EnergyPlus
+    ep_path = OpenStudio.getEnergyPlusExecutable
+
+    puts "EnergyPlus is: #{ep_path}"
+    job = "energyplus -w #{epw_path.to_s} -d #{run_dir} #{idf_path.to_s}"
+    puts job
+    system(job)
+
+    sql_path = OpenStudio::Path.new("#{run_dir}/eplusout.sql")
+
+    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Finished run.')
+
+    # @todo Delete the eplustbl.htm and other files created by the run for cleanliness.
+
+    if OpenStudio.exists(sql_path)
+      sql = OpenStudio::SqlFile.new(sql_path)
+      # Check to make sure the sql file is readable,
+      # which won't be true if EnergyPlus crashed during simulation.
+      unless sql.connectionOpen
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "The run failed, cannot create model.  Look at the eplusout.err file in #{File.dirname(sql_path.to_s)} to see the cause.")
+        return false
+      end
+    else
+      # If the sql file does not exist, it is likely that EnergyPlus crashed,
+      # in which case the useful errors are inside the eplusout.err file.
+      err_file_path_string = "#{run_dir}/run/eplusout.err"
+      err_file_path = OpenStudio::Path.new(err_file_path_string)
+      if OpenStudio.exists(err_file_path)
+        if __dir__[0] == ':' # Running from OpenStudio CLI
+          errs = EmbeddedScripting.getFileAsString(err_file_path_string)
+        else
+          errs = File.read(err_file_path_string)
+        end
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "The run did not finish because of the following errors: #{errs}")
+        return false
+      else
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Results for the run couldn't be found here: #{sql_path}.")
+        return false
+      end
+    end
+
+    # todo - figure out how to get code below to work so method returns false when simulation fails
+
+    # # Report severe or fatal errors in the run
+    # error_query = "SELECT ErrorMessage
+    #     FROM Errors
+    #     WHERE ErrorType in(1,2)"
+    # errs = model.sqlFile.get.execAndReturnVectorOfString(error_query)
+    # if errs.is_initialized
+    #   errs = errs.get
+    # end
+
+    # # Check that the run completed successfully
+    # end_file_stringpath = "#{run_dir}/run/eplusout.end"
+    # end_file_path = OpenStudio::Path.new(end_file_stringpath)
+    # if OpenStudio.exists(end_file_path)
+    #   endstring = File.read(end_file_stringpath)
+    # end
+
+    # if !endstring.include?('EnergyPlus Completed Successfully')
+    #   OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "The run did not finish and had following errors: #{errs.join('\n')}")
+    #   return false
+    # end
+
+    # # Log any severe errors that did not cause simulation to fail
+    # unless errs.empty?
+    #   OpenStudio.logFree(OpenStudio::Warn, 'openstudio.model.Model', "The run completed but had the following severe errors: #{errs.join('\n')}")
+    # end
+
+    return true
+  end  
+
   def test_good_argument_values
     # create an instance of the measure
     measure = AddPackagedIceStorage.new
@@ -82,14 +153,68 @@ class AddPackagedIceStorageTest < MiniTest::Test
 
     # run the measure
     measure.run(workspace, runner, argument_map)
+
+    # run the annual simulation
+    output_file_path = "#{File.dirname(__FILE__)}/output/test_good_argument_values/Run"
+    #sim_results = self.model_run_simulation_and_log_errors(workspace, output_file_path)
+    #assert(sim_results)
+    # todo - need to add code so test fails if simulation fails
+
     result = runner.result
     assert_equal('Success', result.value.valueName)
 
     show_output(result)
 
-    # save the workspace to output directory
-    output_file_path = OpenStudio::Path.new("#{File.dirname(__FILE__)}/output/test_output.idf")
-    workspace.save(output_file_path, true)
+    true
+  end
+
+  def test_single_speed_dx
+    # create an instance of the measure
+    measure = AddPackagedIceStorage.new
+
+    # create runner with empty OSW
+    osw = OpenStudio::WorkflowJSON.new
+    runner = OpenStudio::Measure::OSRunner.new(osw)
+
+    # load the test model
+    translator = OpenStudio::OSVersion::VersionTranslator.new
+    path = OpenStudio::Path.new("#{File.dirname(__FILE__)}/single_speed_dx_350.osm")
+    model = translator.loadModel(path)
+    assert(!model.empty?)
+    model = model.get
+
+    # forward translate OSM file to IDF file
+    ft = OpenStudio::EnergyPlus::ForwardTranslator.new
+    workspace = ft.translateModel(model)
+
+    # get arguments
+    arguments = measure.arguments(workspace)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    # create hash of argument values
+    args_hash = {}
+    #args_hash['ice_cap'] = '40,50'
+
+    # populate argument with specified has value if set
+    arguments.each do |arg|
+      temp_arg_var = arg.clone
+      assert(temp_arg_var.setValue(args_hash[arg.name])) if args_hash[arg.name]
+      argument_map[arg.name] = temp_arg_var
+    end
+
+    # run the measure
+    measure.run(workspace, runner, argument_map)
+
+    # run the annual simulation
+    output_file_path = "#{File.dirname(__FILE__)}/output/single_speed_dx/Run"
+    #sim_results = self.model_run_simulation_and_log_errors(workspace, output_file_path)
+    #assert(sim_results)
+    # todo - need to add code so test fails if simulation fails
+
+    result = runner.result
+    assert_equal('Success', result.value.valueName)
+
+    show_output(result)
 
     true
   end