openstudio-load-flexibility-measures 0.5.0 → 0.6.0

data/lib/measures/ShiftScheduleByType/tests/ShiftScheduleByType_Test.rb

@@ -0,0 +1,193 @@
+# *******************************************************************************
+# 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.
+# *******************************************************************************
+
+require 'openstudio'
+require 'openstudio/measure/ShowRunnerOutput'
+require 'fileutils'
+
+require_relative '../measure.rb'
+require 'minitest/autorun'
+
+class ShiftScheduleByType_Test < Minitest::Test
+  def test_ShiftScheduleByType_a
+    # create an instance of the measure
+    measure = ShiftScheduleByType.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    # load the test model
+    translator = OpenStudio::OSVersion::VersionTranslator.new
+    path = OpenStudio::Path.new(File.dirname(__FILE__) + '/3Story2Space.osm')
+    model = translator.loadModel(path)
+    assert(!model.empty?)
+    model = model.get
+
+    # set argument values to good values and run the measure on model with spaces
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    shift_value = arguments[0].clone
+    assert(shift_value.setValue(1.5))
+    argument_map['shift_value'] = shift_value
+
+    schedchoice = arguments[1].clone
+    assert(schedchoice.setValue('CoolHeat'))
+    argument_map['schedchoice'] = schedchoice
+
+    measure.run(model, runner, argument_map)
+    result = runner.result
+    show_output(result)
+    assert(result.value.valueName == 'Success')
+    assert(result.warnings.empty?)
+    # assert(result.info.size == 5)
+
+    # save the model
+    # output_file_path = OpenStudio::Path.new('C:\SVN_Utilities\OpenStudio\measures\test.osm')
+    # model.save(output_file_path,true)
+  end
+
+  def test_ShiftScheduleByType_b
+    # create an instance of the measure
+    measure = ShiftScheduleByType.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    # load the test model
+    translator = OpenStudio::OSVersion::VersionTranslator.new
+    path = OpenStudio::Path.new(File.dirname(__FILE__) + '/3Story2Space.osm')
+    model = translator.loadModel(path)
+    assert(!model.empty?)
+    model = model.get
+
+    # set argument values to good values and run the measure on model with spaces
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    shift_value = arguments[0].clone
+    assert(shift_value.setValue(-6.0))
+    argument_map['shift_value'] = shift_value
+
+    schedchoice = arguments[1].clone
+    assert(schedchoice.setValue('CoolHeat'))
+    argument_map['schedchoice'] = schedchoice
+
+    measure.run(model, runner, argument_map)
+    result = runner.result
+    show_output(result)
+    assert(result.value.valueName == 'Success')
+    assert(result.warnings.empty?)
+    # assert(result.info.size == 5)
+
+    # save the model
+    # output_file_path = OpenStudio::Path.new('C:\SVN_Utilities\OpenStudio\measures\test.osm')
+    # model.save(output_file_path,true)
+  end
+
+  def test_ShiftScheduleByType_all_schedules
+    # create an instance of the measure
+    measure = ShiftScheduleByType.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    # load the test model
+    translator = OpenStudio::OSVersion::VersionTranslator.new
+    path = OpenStudio::Path.new(File.dirname(__FILE__) + '/3Story2Space.osm')
+    model = translator.loadModel(path)
+    assert(!model.empty?)
+    model = model.get
+
+    # set argument values to good values and run the measure on model with spaces
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    shift_value = arguments[0].clone
+    assert(shift_value.setValue(-6.0))
+    argument_map['shift_value'] = shift_value
+
+    schedchoice = arguments[1].clone
+    assert(schedchoice.setValue('CoolHeat'))
+    argument_map['schedchoice'] = schedchoice
+
+    measure.run(model, runner, argument_map)
+    result = runner.result
+    show_output(result)
+    assert(result.value.valueName == 'Success')
+    # assert(result.warnings.size == 0)
+    # assert(result.info.size == 5)
+
+    # save the model
+    # output_file_path = OpenStudio::Path.new('C:\SVN_Utilities\OpenStudio\measures\test.osm')
+    # model.save(output_file_path,true)
+  end
+
+  def test_ShiftScheduleByType_NA
+    # create an instance of the measure
+    measure = ShiftScheduleByType.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    # load the test model
+    translator = OpenStudio::OSVersion::VersionTranslator.new
+    path = OpenStudio::Path.new(File.dirname(__FILE__) + '/3Story2Space.osm')
+    model = translator.loadModel(path)
+    assert(!model.empty?)
+    model = model.get
+
+    # set argument values to good values and run the measure on model with spaces
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    shift_value = arguments[0].clone
+    assert(shift_value.setValue(24))
+    argument_map['shift_value'] = shift_value
+
+    schedchoice = arguments[1].clone
+    assert(schedchoice.setValue('CoolHeat'))
+    argument_map['schedchoice'] = schedchoice
+
+    measure.run(model, runner, argument_map)
+    result = runner.result
+    show_output(result)
+    assert(result.value.valueName == 'NA')
+
+    # save the model
+    # output_file_path = OpenStudio::Path.new('C:\SVN_Utilities\OpenStudio\measures\test.osm')
+    # model.save(output_file_path,true)
+  end
+end

data/lib/measures/add_central_ice_storage/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+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:

data/lib/measures/add_central_ice_storage/measure.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# 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:
@@ -457,7 +457,7 @@ class AddCentralIceStorage < OpenStudio::Measure::ModelMeasure
 
     # Check limits of chiller performance curves and adjust if necessary - Notify user with WARNING
     curve_output_check = false
-    cap_ft = ctes_chiller.coolingCapacityFunctionOfTemperature
+    cap_ft = ctes_chiller.coolingCapacityFunctionOfTemperature.to_CurveBiquadratic.get
     min_x = cap_ft.minimumValueofx.to_f
     if min_x > chg_sp
       cap_ft.setMinimumValueofx(chg_sp)
@@ -467,7 +467,7 @@ class AddCentralIceStorage < OpenStudio::Measure::ModelMeasure
       curve_output_check = true
     end
 
-    eir_ft = ctes_chiller.electricInputToCoolingOutputRatioFunctionOfTemperature
+    eir_ft = ctes_chiller.electricInputToCoolingOutputRatioFunctionOfTemperature.to_CurveBiquadratic.get
     min_x = eir_ft.minimumValueofx.to_f
     if min_x > chg_sp
       runner.registerWarning("VERIFY CURVE VALIDITY: The input range for the '#{eir_ft.name}' curve is too " \

data/lib/measures/add_central_ice_storage/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>add_central_ice_storage</name>
   <uid>48f37812-0cb6-4770-b695-beb8d8a5660d</uid>
-  <version_id>f8f68f4a-4f32-4051-8f1f-0ec842998763</version_id>
-  <version_modified>20220505T192248Z</version_modified>
+  <version_id>ed2dd58f-3a63-40a3-8518-924757ed8471</version_id>
+  <version_modified>20221129T221355Z</version_modified>
   <xml_checksum>6394841D</xml_checksum>
   <class_name>AddCentralIceStorage</class_name>
   <display_name>Add Central Ice Storage</display_name>
@@ -474,19 +474,19 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>64FFEBDE</checksum>
     </file>
     <file>
       <filename>OsLib_Schedules.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>64AFEC72</checksum>
+      <checksum>0582294E</checksum>
     </file>
     <file>
       <filename>add_central_ice_storage_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>10164E33</checksum>
+      <checksum>B4007921</checksum>
     </file>
     <file>
       <version>
@@ -497,7 +497,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>C16EDFB8</checksum>
+      <checksum>8884BAF8</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/add_central_ice_storage/resources/OsLib_Schedules.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/measures/add_central_ice_storage/tests/add_central_ice_storage_test.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/measures/add_hpwh/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+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:

data/lib/measures/add_hpwh/measure.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/measures/add_hpwh/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>add_hpwh</name>
   <uid>518cde6f-1806-4b9a-bee9-ccaac49c7a53</uid>
-  <version_id>67268596-50cb-4f0e-8fc2-9c6b5690ceb3</version_id>
-  <version_modified>20220505T192247Z</version_modified>
+  <version_id>5f32552c-4726-4ed6-b89a-a991afaecd60</version_id>
+  <version_modified>20221011T225330Z</version_modified>
   <xml_checksum>A374667A</xml_checksum>
   <class_name>AddHpwh</class_name>
   <display_name>Add HPWH for Domestic Hot Water</display_name>
@@ -379,7 +379,7 @@ The flexibility of the system is based on user-defined temperatures and times, w
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>64FFEBDE</checksum>
     </file>
     <file>
       <version>
@@ -390,13 +390,13 @@ The flexibility of the system is based on user-defined temperatures and times, w
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>B3DC865B</checksum>
+      <checksum>BDB9B944</checksum>
     </file>
     <file>
       <filename>add_hpwh_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>DB9A9CE2</checksum>
+      <checksum>85B7D1A6</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/add_hpwh/tests/add_hpwh_test.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/measures/add_packaged_ice_storage/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+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:

data/lib/measures/add_packaged_ice_storage/measure.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/measures/add_packaged_ice_storage/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>add_packaged_ice_storage</name>
   <uid>2aa8c128-53b9-49fd-9aaf-9253a1f05936</uid>
-  <version_id>0169e58e-3682-493d-a4a3-60e58eca98d8</version_id>
-  <version_modified>20220505T192248Z</version_modified>
+  <version_id>12ace3fc-b9d5-4236-9087-9c2fb61ec8c2</version_id>
+  <version_modified>20221011T225330Z</version_modified>
   <xml_checksum>2617824F</xml_checksum>
   <class_name>AddPackagedIceStorage</class_name>
   <display_name>Add Packaged Ice Storage</display_name>
@@ -222,13 +222,13 @@ If 'AutoSize' is selected for ice capacity, these inputs set an ice capacity siz
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>64FFEBDE</checksum>
     </file>
     <file>
       <filename>add_packaged_ice_storage_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>B73245BC</checksum>
+      <checksum>F32CF657</checksum>
     </file>
     <file>
       <version>
@@ -239,7 +239,7 @@ If 'AutoSize' is selected for ice capacity, these inputs set an ice capacity siz
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>4AE2C2E6</checksum>
+      <checksum>85F2A9C5</checksum>
     </file>
   </files>
 </measure>

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

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/openstudio/load_flexibility_measures/version.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# 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:
@@ -35,6 +35,6 @@
 
 module OpenStudio
   module LoadFlexibilityMeasures
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

data/lib/openstudio/load_flexibility_measures.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# 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:

data/openstudio-load-flexibility-measures.gemspec

@@ -24,8 +24,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2.7.0'
 
   spec.add_dependency 'bundler', '~> 2.1'
-  spec.add_dependency 'openstudio-extension', '~> 0.5.1'
-  spec.add_dependency 'openstudio-standards', '~> 0.2.16'
+
+  spec.add_dependency 'openstudio-extension', '~> 0.6.0'
+  spec.add_dependency 'openstudio-standards', '~> 0.3.0'
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-load-flexibility-measures
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Karl Heine
 - Ryan Meyer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,28 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: openstudio-standards
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.16
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.16
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +117,13 @@ files:
 - doc_templates/copyright_erb.txt
 - doc_templates/copyright_js.txt
 - doc_templates/copyright_ruby.txt
+- lib/measures/ShiftScheduleByType/LICENSE.md
+- lib/measures/ShiftScheduleByType/README.md
+- lib/measures/ShiftScheduleByType/README.md.erb
+- lib/measures/ShiftScheduleByType/measure.rb
+- lib/measures/ShiftScheduleByType/measure.xml
+- lib/measures/ShiftScheduleByType/tests/3Story2Space.osm
+- lib/measures/ShiftScheduleByType/tests/ShiftScheduleByType_Test.rb
 - lib/measures/add_central_ice_storage/LICENSE.md
 - lib/measures/add_central_ice_storage/README.md
 - lib/measures/add_central_ice_storage/README.md.erb
@@ -148,7 +155,7 @@ files:
 homepage: https://openstudio.net
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: library and measures for OpenStudio for load flexibility applications.
 test_files: []