openstudio-load-flexibility-measures 0.1.2 → 0.3.1

data/lib/measures/{add_distributed_ice_storage_to_air_loop_for_load_flexibility → add_packaged_ice_storage}/README.md

@@ -1,4 +1,4 @@
-# Guide for Using Replace Cooling Cool with Packaged Ice Storage Unit Measure
+# Guide for the Add Packaged Ice Storage Measure
 
 ## Description
 This measure removes the cooling coils in the model and replaces them with packaged air conditioning units with integrated ice storage.
@@ -8,7 +8,7 @@ This measure applies to packaged single zone air conditioning systems or package
 
 Users inputs are accepted for cooling coil size, ice storage size, system control method, modes of operation, and operating schedule.
 
-The measure requires schedule objects and performance curves from an included resource file TESCurves.idf. Output variables of typical interest are included as well..
+The measure requires schedule objects and performance curves from an included resource file TESCurves.idf. Output variables of typical interest are included as well.
 
 ## Measure Type
 EnergyPlus Measure
@@ -30,7 +30,7 @@ This measure is built to simulate packaged ice storage units which integrate wit
 ## How the Measure Works
 The measure works by replacing user-selected single-speed and two-speed cooling coils (all applicable coils are pre-selected by default) with *Coil:Cooling:DX:SingleSpeed:ThermalStorage* objects. These TES units may be AutoSized, or hard-sized
 
-An Energy Management System (EMS) program is created for each new TES coil. The default controller turns ice charging and discharging on/off based on ice storage tank end fraction (state of charge). If users desire advanced control strategies, the EMS code may be modified directly in the "measure.rb" file (line 663 ff.). The default controller includes state-of-charge criteria that must be met before ice re-charging is permitted. This value is set at 70%, but may be manually adjusted within the measure.rb file at line 681. A built-in Schedule Modes controller is also available.
+An Energy Management System (EMS) program is created for each new TES coil. The default controller turns ice charging and discharging on/off based on ice storage tank end fraction (state of charge) and user-defined operating schedule. If users desire advanced control strategies, the EMS code may be modified directly in the "measure.rb" file (line 663 ff.). A built-in Schedule Modes controller is also available.
 
 Whether EMS Control or Schedule Modes are used, a charge/discharge schedule is required. The default is a simple schedule created by user inputs. Ice storage capacity is based on the ice discharge window.
 

data/lib/measures/{add_distributed_ice_storage_to_air_loop_for_load_flexibility → add_packaged_ice_storage}/measure.rb

@@ -37,10 +37,10 @@
 # Measure Renamed, License Updated, and Code Cleaned - KH June 2020
 
 # start the measure
-class AddDistributedIceStorageToAirLoopForLoadFlexibility < OpenStudio::Measure::EnergyPlusMeasure
+class AddPackagedIceStorage < OpenStudio::Measure::EnergyPlusMeasure
   # human readable name
   def name
-    'Add Distributed Ice Storage to Air Loop for Load Flexibility'
+    'Add Packaged Ice Storage'
   end
 
   # human readable description
@@ -61,11 +61,11 @@ class AddDistributedIceStorageToAirLoopForLoadFlexibility < OpenStudio::Measure:
   def arguments(workspace)
     args = OpenStudio::Measure::OSArgumentVector.new
 
-    # Add a delimiter for clarify
-    delimiter = OpenStudio::Measure::OSArgument.makeStringArgument('delimiter', false)
-    delimiter.setDisplayName('Select Coils to Replace:')
-    delimiter.setDefaultValue('-----------------------------------------------------------------')
-    args << delimiter
+    # # Add a delimiter for clarify
+    # delimiter = OpenStudio::Measure::OSArgument.makeStringArgument('delimiter', false)
+    # delimiter.setDisplayName('Select Coils to Replace:')
+    # delimiter.setDefaultValue('-----------------------------------------------------------------')
+    # args << delimiter
 
     # get existing dx coils for user selection
     coils = workspace.getObjectsByType('Coil:Cooling:DX:SingleSpeed'.to_IddObjectType)
@@ -82,6 +82,7 @@ class AddDistributedIceStorageToAirLoopForLoadFlexibility < OpenStudio::Measure:
       coil_selection = OpenStudio::Measure::OSArgument.makeBoolArgument(k, true)
       coil_selection.setDisplayName(k)
       coil_selection.setDefaultValue(v)
+      coil_selection.setDescription('Replace this coil?')
       args << coil_selection
     end
 
@@ -687,4 +688,4 @@ class AddDistributedIceStorageToAirLoopForLoadFlexibility < OpenStudio::Measure:
 end
 
 # register the measure to be used by the application
-AddDistributedIceStorageToAirLoopForLoadFlexibility.new.registerWithApplication
+AddPackagedIceStorage.new.registerWithApplication

data/lib/measures/{add_distributed_ice_storage_to_air_loop_for_load_flexibility → add_packaged_ice_storage}/measure.xml

@@ -1,13 +1,13 @@
 <?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
-  <name>add_distributed_ice_storage_to_air_loop_for_load_flexibility</name>
+  <name>add_packaged_ice_storage</name>
   <uid>2aa8c128-53b9-49fd-9aaf-9253a1f05936</uid>
-  <version_id>8b55d314-a611-495a-bbc3-47cdd3ed9e86</version_id>
-  <version_modified>20200806T183852Z</version_modified>
+  <version_id>1a0ab79e-1825-4418-a4ad-aec2194d4707</version_id>
+  <version_modified>20201208T224029Z</version_modified>
   <xml_checksum>2617824F</xml_checksum>
-  <class_name>AddDistributedIceStorageToAirLoopForLoadFlexibility</class_name>
-  <display_name>Add Distributed Ice Storage to Air Loop for Load Flexibility</display_name>
+  <class_name>AddPackagedIceStorage</class_name>
+  <display_name>Add Packaged Ice Storage</display_name>
   <description>This measure removes the cooling coils in the model and replaces them with packaged air conditioning units with integrated ice storage.</description>
   <modeler_description>This measure applies to packaged single zone air conditioning systems or packaged variable air volume systems that were originally modeled with CoilSystem:Cooling:DX or AirLoopHVAC:UnitarySystem container objects. It adds a Coil:Cooling:DX:SingleSpeed:ThermalStorage coil object to each user-selected thermal zone and deletes the existing cooling coil.
 
@@ -15,14 +15,6 @@
 
     The measure requires schedule objects and performance curves from an included resource file TESCurves.idf. Output variables of typical interest are included as well.</modeler_description>
   <arguments>
-    <argument>
-      <name>delimiter</name>
-      <display_name>Select Coils to Replace:</display_name>
-      <type>String</type>
-      <required>false</required>
-      <model_dependent>false</model_dependent>
-      <default_value>-----------------------------------------------------------------</default_value>
-    </argument>
     <argument>
       <name>ice_cap</name>
       <display_name>Input the ice storage capacity [ton-hours]</display_name>
@@ -220,12 +212,6 @@ If 'AutoSize' is selected for ice capacity, these inputs set an ice capacity siz
       <usage_type>test</usage_type>
       <checksum>DC0DCC4B</checksum>
     </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>B27484F2</checksum>
-    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
@@ -233,10 +219,16 @@ If 'AutoSize' is selected for ice capacity, these inputs set an ice capacity siz
       <checksum>E0468DD6</checksum>
     </file>
     <file>
-      <filename>add_distributed_ice_storage_to_air_loop_for_load_flexibility_test.rb</filename>
+      <filename>add_packaged_ice_storage_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>FC11EAC7</checksum>
+      <checksum>2D918464</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>A67F3738</checksum>
     </file>
     <file>
       <version>
@@ -247,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>AFBDDEF7</checksum>
+      <checksum>749A70A0</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/{add_distributed_ice_storage_to_air_loop_for_load_flexibility/tests/add_distributed_ice_storage_to_air_loop_for_load_flexibility_test.rb → add_packaged_ice_storage/tests/add_packaged_ice_storage_test.rb}

@@ -39,7 +39,7 @@ require 'minitest/autorun'
 
 require_relative '../measure.rb'
 
-class AddDistributedIceStorageToAirLoopForLoadFlexibilityTest < MiniTest::Test
+class AddPackagedIceStorageTest < MiniTest::Test
   # def setup
   # end
 
@@ -48,7 +48,7 @@ class AddDistributedIceStorageToAirLoopForLoadFlexibilityTest < MiniTest::Test
 
   def test_good_argument_values
     # create an instance of the measure
-    measure = AddDistributedIceStorageToAirLoopForLoadFlexibility.new
+    measure = AddPackagedIceStorage.new
 
     # create runner with empty OSW
     osw = OpenStudio::WorkflowJSON.new

data/lib/openstudio/load_flexibility_measures/version.rb

@@ -35,6 +35,6 @@
 
 module OpenStudio
   module LoadFlexibilityMeasures
-    VERSION = '0.1.2'.freeze
+    VERSION = '0.3.1'.freeze
   end
 end

data/openstudio-load-flexibility-measures.gemspec

@@ -22,11 +22,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '~> 2.7.0'
+
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rubocop', '~> 0.54.0'
 
-  spec.add_dependency 'openstudio-extension', '~> 0.2.4'
-  spec.add_dependency 'openstudio-standards', '~> 0.2.11'
+  spec.add_dependency 'openstudio-extension', '~> 0.4.2'
+  spec.add_dependency 'openstudio-standards', '~> 0.2.13'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-load-flexibility-measures
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Karl Heine
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,28 +73,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: openstudio-standards
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.11
+        version: 0.2.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.11
+        version: 0.2.13
 description: library and measures for OpenStudio for load flexibility applications.
 email:
 - karl.heine@nrel.gov
@@ -105,8 +105,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.html
 - CHANGELOG.md
 - Gemfile
+- Jenkinsfile
 - README.md
 - Rakefile
 - doc_templates/LICENSE.md
@@ -114,33 +116,31 @@ files:
 - doc_templates/copyright_erb.txt
 - doc_templates/copyright_js.txt
 - doc_templates/copyright_ruby.txt
-- lib/measures/add_central_hpwh_for_load_flexibility/LICENSE.md
-- lib/measures/add_central_hpwh_for_load_flexibility/README.md
-- lib/measures/add_central_hpwh_for_load_flexibility/README.md.erb
-- lib/measures/add_central_hpwh_for_load_flexibility/docs/Flexible Domestic Hot Water
-  Implementation Guide.pdf
-- lib/measures/add_central_hpwh_for_load_flexibility/measure.rb
-- lib/measures/add_central_hpwh_for_load_flexibility/measure.xml
-- lib/measures/add_central_hpwh_for_load_flexibility/tests/SmallHotel-2A.osm
-- lib/measures/add_central_hpwh_for_load_flexibility/tests/add_central_hpwh_for_load_flexibility.rb
-- lib/measures/add_distributed_ice_storage_to_air_loop_for_load_flexibility/LICENSE.md
-- lib/measures/add_distributed_ice_storage_to_air_loop_for_load_flexibility/README.md
-- lib/measures/add_distributed_ice_storage_to_air_loop_for_load_flexibility/measure.rb
-- lib/measures/add_distributed_ice_storage_to_air_loop_for_load_flexibility/measure.xml
-- lib/measures/add_distributed_ice_storage_to_air_loop_for_load_flexibility/resources/TESCurves.idf
-- lib/measures/add_distributed_ice_storage_to_air_loop_for_load_flexibility/tests/MeasureTest.osm
-- lib/measures/add_distributed_ice_storage_to_air_loop_for_load_flexibility/tests/add_distributed_ice_storage_to_air_loop_for_load_flexibility_test.rb
-- lib/measures/add_distributed_ice_storage_to_air_loop_for_load_flexibility/tests/output/test_output.idf
-- lib/measures/add_ice_storage_to_plant_loop_for_load_flexibility/LICENSE.md
-- lib/measures/add_ice_storage_to_plant_loop_for_load_flexibility/README.md
-- lib/measures/add_ice_storage_to_plant_loop_for_load_flexibility/README.md.erb
-- lib/measures/add_ice_storage_to_plant_loop_for_load_flexibility/docs/Ice Measure
-  Implementation Guide.pdf
-- lib/measures/add_ice_storage_to_plant_loop_for_load_flexibility/measure.rb
-- lib/measures/add_ice_storage_to_plant_loop_for_load_flexibility/measure.xml
-- lib/measures/add_ice_storage_to_plant_loop_for_load_flexibility/resources/OsLib_Schedules.rb
-- lib/measures/add_ice_storage_to_plant_loop_for_load_flexibility/tests/add_ice_storage_to_plant_loop_for_load_flexibility_test.rb
-- lib/measures/add_ice_storage_to_plant_loop_for_load_flexibility/tests/ice_test_model.osm
+- 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
+- lib/measures/add_central_ice_storage/docs/Ice Measure Implementation Guide.pdf
+- lib/measures/add_central_ice_storage/measure.rb
+- lib/measures/add_central_ice_storage/measure.xml
+- lib/measures/add_central_ice_storage/resources/OsLib_Schedules.rb
+- lib/measures/add_central_ice_storage/tests/add_central_ice_storage_test.rb
+- lib/measures/add_central_ice_storage/tests/ice_test_model.osm
+- lib/measures/add_hpwh/LICENSE.md
+- lib/measures/add_hpwh/README.md
+- lib/measures/add_hpwh/README.md.erb
+- lib/measures/add_hpwh/docs/Flexible Domestic Hot Water Implementation Guide.pdf
+- lib/measures/add_hpwh/measure.rb
+- lib/measures/add_hpwh/measure.xml
+- lib/measures/add_hpwh/tests/SmallHotel-2A.osm
+- lib/measures/add_hpwh/tests/add_hphw_test.rb
+- lib/measures/add_packaged_ice_storage/LICENSE.md
+- lib/measures/add_packaged_ice_storage/README.html
+- lib/measures/add_packaged_ice_storage/README.md
+- lib/measures/add_packaged_ice_storage/measure.rb
+- lib/measures/add_packaged_ice_storage/measure.xml
+- lib/measures/add_packaged_ice_storage/resources/TESCurves.idf
+- lib/measures/add_packaged_ice_storage/tests/MeasureTest.osm
+- lib/measures/add_packaged_ice_storage/tests/add_packaged_ice_storage_test.rb
 - lib/openstudio/load_flexibility_measures.rb
 - lib/openstudio/load_flexibility_measures/version.rb
 - openstudio-load-flexibility-measures.gemspec
@@ -153,17 +153,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: library and measures for OpenStudio for load flexibility applications.