openstudio-load-flexibility-measures 0.1.1 → 0.3.0

data/lib/measures/{add_ice_storage_to_plant_loop_for_load_flexibility → add_central_ice_storage}/measure.xml

@@ -1,13 +1,13 @@
 <?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
-  <name>add_ice_storage_to_plant_loop_for_load_flexibility</name>
+  <name>add_central_ice_storage</name>
   <uid>48f37812-0cb6-4770-b695-beb8d8a5660d</uid>
-  <version_id>ec8fce33-0983-427d-baf9-624b66c9bdb6</version_id>
-  <version_modified>20200729T185358Z</version_modified>
+  <version_id>2972286b-0047-4d40-90bf-c0c56a7a5799</version_id>
+  <version_modified>20201203T034326Z</version_modified>
   <xml_checksum>6394841D</xml_checksum>
-  <class_name>AddIceStorageToPlantLoopForLoadFlexibility</class_name>
-  <display_name>Add Ice Storage Tank</display_name>
+  <class_name>AddCentralIceStorage</class_name>
+  <display_name>Add Central Ice Storage</display_name>
   <description>This measure adds an ice storage tank to a chilled water loop for the purpose of thermal energy storage.</description>
   <modeler_description>This measure adds the necessary components and performs required model articulations to add an ice thermal storage tank (ITS) to an existing chilled water loop. Special consideration is given to implementing configuration and control options. Refer to the ASHRAE CTES Design Guide or manufacturer applications guides for detailed implementation info. A user guide document is included in the docs folder of this measure to help translate design objectives into measure argument input values.</modeler_description>
   <arguments>
@@ -97,7 +97,7 @@
       <type>Double</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
-      <default_value>0.7</default_value>
+      <default_value>0.75</default_value>
     </argument>
     <argument>
       <name>chiller_limit</name>
@@ -106,11 +106,11 @@
       <type>Double</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
-      <default_value>0.75</default_value>
+      <default_value>1</default_value>
     </argument>
     <argument>
       <name>old</name>
-      <display_name>Use Existing (Pre-Defined) Temperature Control Schedules?</display_name>
+      <display_name>Use Existing (Pre-Defined) Temperature Control Schedules</display_name>
       <description>Use drop-down selections below.</description>
       <type>Boolean</type>
       <required>false</required>
@@ -171,7 +171,7 @@
     </argument>
     <argument>
       <name>new</name>
-      <display_name>Create New (Simple) Temperature Control Schedules?</display_name>
+      <display_name>Create New (Simple) Temperature Control Schedules</display_name>
       <description>Use entry fields below. If Pre-Defined is also selected, these new schedules will be created but not applied.</description>
       <type>Boolean</type>
       <required>false</required>
@@ -270,7 +270,7 @@
     </argument>
     <argument>
       <name>wknds</name>
-      <display_name>Allow Ice Discharge on Weekends?</display_name>
+      <display_name>Allow Ice Discharge on Weekends</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -323,8 +323,7 @@
     </argument>
     <argument>
       <name>dr</name>
-      <display_name>Test Demand Reponse Event?</display_name>
-      <description></description>
+      <display_name>Test Demand Reponse Event</display_name>
       <type>Boolean</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
@@ -343,7 +342,6 @@
     <argument>
       <name>dr_add_shed</name>
       <display_name>Select if a Load Add or Load Shed Event</display_name>
-      <description></description>
       <type>Choice</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
@@ -380,7 +378,6 @@
     <argument>
       <name>dr_dur</name>
       <display_name>Enter duration of demand response event [hr]:</display_name>
-      <description></description>
       <type>Double</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
@@ -388,7 +385,7 @@
     </argument>
     <argument>
       <name>dr_chill</name>
-      <display_name>Allow chiller to back-up ice during DR event?</display_name>
+      <display_name>Allow chiller to back-up ice during DR event</display_name>
       <description>Unselection may result in unmet cooling hours</description>
       <type>Boolean</type>
       <required>false</required>
@@ -461,24 +458,12 @@
       <usage_type>test</usage_type>
       <checksum>A3FC1180</checksum>
     </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>59B484B4</checksum>
-    </file>
     <file>
       <filename>Ice Measure Implementation Guide.pdf</filename>
       <filetype>pdf</filetype>
       <usage_type>doc</usage_type>
       <checksum>090841B0</checksum>
     </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>F360189C</checksum>
-    </file>
     <file>
       <filename>OsLib_Schedules.rb</filename>
       <filetype>rb</filetype>
@@ -486,21 +471,33 @@
       <checksum>2F6D3DE2</checksum>
     </file>
     <file>
-      <filename>add_ice_storage_to_plant_loop_for_load_flexibility_test.rb</filename>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>E0468DD6</checksum>
+    </file>
+    <file>
+      <filename>add_central_ice_storage_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>7C4811E5</checksum>
+      <checksum>8738374B</checksum>
     </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
-        <identifier>2.7.1</identifier>
+        <identifier>3.0.0</identifier>
         <min_compatible>2.7.1</min_compatible>
       </version>
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>E05DCD4F</checksum>
+      <checksum>F06BB506</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>962B1D2E</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/{add_ice_storage_to_plant_loop_for_load_flexibility/tests/add_ice_storage_to_plant_loop_for_load_flexibility_test.rb → add_central_ice_storage/tests/add_central_ice_storage_test.rb}

@@ -41,7 +41,7 @@ require 'minitest/autorun'
 require_relative '../measure.rb'
 require 'fileutils'
 
-class AddIceStorageToPlantLoopForLoadFlexibilityTest < Minitest::Test
+class AddCentralIceStorageTest < Minitest::Test
   # def setup
   # end
 
@@ -50,7 +50,7 @@ class AddIceStorageToPlantLoopForLoadFlexibilityTest < Minitest::Test
 
   def test_number_of_arguments_and_argument_names
     # create an instance of the measure
-    measure = AddIceStorageToPlantLoopForLoadFlexibility.new
+    measure = AddCentralIceStorage.new
 
     # create runner with empty OSW
     osw = OpenStudio::WorkflowJSON.new
@@ -96,7 +96,7 @@ class AddIceStorageToPlantLoopForLoadFlexibilityTest < Minitest::Test
 
   def test_bad_argument_values
     # create an instance of the measure
-    measure = AddIceStorageToPlantLoopForLoadFlexibility.new
+    measure = AddCentralIceStorage.new
 
     # create runner with empty OSW
     osw = OpenStudio::WorkflowJSON.new
@@ -135,7 +135,7 @@ class AddIceStorageToPlantLoopForLoadFlexibilityTest < Minitest::Test
 
   def test_good_argument_values
     # create an instance of the measure
-    measure = AddIceStorageToPlantLoopForLoadFlexibility.new
+    measure = AddCentralIceStorage.new
 
     # create runner with empty OSW
     osw = OpenStudio::WorkflowJSON.new
@@ -160,6 +160,7 @@ class AddIceStorageToPlantLoopForLoadFlexibilityTest < Minitest::Test
     args_hash['storage_capacity'] = 550
     args_hash['melt_indicator'] = 'InsideMelt'
     args_hash['chiller_resize_factor'] = 0.75
+    args_hash['chiller_limit'] = 0.7
     args_hash['chg_sp'] = 26
     args_hash['loop_sp'] = 42
     args_hash['delta_t'] = '16'

data/lib/measures/add_hpwh/LICENSE.md

@@ -0,0 +1,27 @@
+OpenStudio(R), Copyright (c) 2008-2020, 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 HOLDERS AND 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, THE UNITED STATES GOVERNMENT, 
+OR ANY CONTRIBUTORS 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.

data/lib/measures/{add_central_hpwh_for_load_flexibility → add_hpwh}/README.md

@@ -2,7 +2,7 @@
 
 ###### (Automatically generated documentation)
 
-# flexible_domestic_hot_water
+# Add HPWH for Domestic Hot Water
 
 ## Description
 This measure adds or replaces existing domestic hot water heater with air source heat pump system and allows for the addition of multiple daily flexible control time windows. The heater/tank system may charge at maximum capacity up to an elevated temperature, or float without any heat addition for a specified timeframe down to a minimum tank temperature.
@@ -21,7 +21,7 @@ ModelMeasure
 ## Arguments
 
 
-### Remove existing water heater on selected loop?
+### Remove existing water heater on selected loop
 
 **Name:** remove_wh,
 **Type:** Boolean,
@@ -70,7 +70,7 @@ This is where the water heater tank will be placed
 **Model Dependent:** false
 
 ### Set heat pump rated COP (heating)
-[-]
+
 **Name:** cop,
 **Type:** Double,
 **Units:** ,

data/lib/measures/{add_central_hpwh_for_load_flexibility → add_hpwh}/measure.rb

@@ -43,13 +43,13 @@
 # EnergyPlus Engineering Reference, Sections:
 
 # start the measure
-class AddCentralHPWHForLoadFlexibility < OpenStudio::Measure::ModelMeasure
+class AddHphw < OpenStudio::Measure::ModelMeasure
   require 'openstudio-standards'
 
   # human readable name
   def name
     # Measure name should be the title case of the class name.
-    'flexible_domestic_hot_water'
+    'Add HPWH for Domestic Hot Water'
   end
 
   # human readable description
@@ -87,7 +87,7 @@ class AddCentralHPWHForLoadFlexibility < OpenStudio::Measure::ModelMeasure
 
     # create argument for removal of existing water heater tanks on selected loop
     remove_wh = OpenStudio::Measure::OSArgument.makeBoolArgument('remove_wh', true)
-    remove_wh.setDisplayName('Remove existing water heater on selected loop?')
+    remove_wh.setDisplayName('Remove existing water heater on selected loop')
     remove_wh.setDescription('')
     remove_wh.setDefaultValue(true)
     args << remove_wh
@@ -176,7 +176,6 @@ class AddCentralHPWHForLoadFlexibility < OpenStudio::Measure::ModelMeasure
     # create argument for heat pump rated cop
     cop = OpenStudio::Measure::OSArgument.makeDoubleArgument('cop', true)
     cop.setDisplayName('Set heat pump rated COP (heating)')
-    cop.setDescription('[-]')
     cop.setDefaultValue(2.8)
     args << cop
 
@@ -600,7 +599,7 @@ class AddCentralHPWHForLoadFlexibility < OpenStudio::Measure::ModelMeasure
                   'Water Heater Use Side Heat Transfer Rate',
                   'Water Heater Source Side Heat Transfer Rate',
                   'Water Heater Unmet Demand Heat Transfer Rate',
-                  'Water Heater Electric Power',
+                  'Water Heater Electricity Rate',
                   'Water Heater Water Volume Flow Rate',
                   'Water Use Connections Hot Water Temperature']
 
@@ -645,4 +644,4 @@ class AddCentralHPWHForLoadFlexibility < OpenStudio::Measure::ModelMeasure
 end
 
 # register the measure to be used by the application
-AddCentralHPWHForLoadFlexibility.new.registerWithApplication
+AddHphw.new.registerWithApplication

data/lib/measures/{add_central_hpwh_for_load_flexibility → add_hpwh}/measure.xml

@@ -1,13 +1,13 @@
 <?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
-  <name>add_central_hpwh_for_load_flexibility</name>
+  <name>add_hphw</name>
   <uid>518cde6f-1806-4b9a-bee9-ccaac49c7a53</uid>
-  <version_id>13943fd8-e7ff-41ea-8e90-3c767bcfa466</version_id>
-  <version_modified>20200727T193248Z</version_modified>
+  <version_id>0a64fe16-eef8-4026-a3a6-45fa8dcad162</version_id>
+  <version_modified>20210317T134945Z</version_modified>
   <xml_checksum>A374667A</xml_checksum>
-  <class_name>AddCentralHPWHForLoadFlexibility</class_name>
-  <display_name>flexible_domestic_hot_water</display_name>
+  <class_name>AddHphw</class_name>
+  <display_name>Add HPWH for Domestic Hot Water</display_name>
   <description>This measure adds or replaces existing domestic hot water heater with air source heat pump system and allows for the addition of multiple daily flexible control time windows. The heater/tank system may charge at maximum capacity up to an elevated temperature, or float without any heat addition for a specified timeframe down to a minimum tank temperature.</description>
   <modeler_description>This measure allows selection between three heat pump water heater modeling approaches in EnergyPlus.The user may select between the pumped-condenser or wrapped-condenser objects. They may also elect to use a simplified calculation which does not use the heat pump objects, but instead used an electric resistance heater and approximates the equivalent electrical input that would be required from a heat pump. This expedites simulation at the expense of accuracy. 
 The flexibility of the system is based on user-defined temperatures and times, which are converted into schedule objects. There are four flexibility options. (1) None: normal operation of the DHW system at a fixed tank temperature setpoint. (2) Charge - Heat Pump: the tank is charged to a maximum temperature using only the heat pump. (3) Charge - Electric: the tank is charged using internal electric resistance heaters to a maximum temperature. (4) Float: all heating elements are turned-off for a user-defined time period unless the tank temperature falls below a minimum value. The heat pump will be prioritized in a low tank temperature event, with the electric resistance heaters serving as back-up. 
@@ -15,7 +15,7 @@ The flexibility of the system is based on user-defined temperatures and times, w
   <arguments>
     <argument>
       <name>remove_wh</name>
-      <display_name>Remove existing water heater on selected loop?</display_name>
+      <display_name>Remove existing water heater on selected loop</display_name>
       <description></description>
       <type>Boolean</type>
       <required>true</required>
@@ -106,7 +106,6 @@ The flexibility of the system is based on user-defined temperatures and times, w
     <argument>
       <name>cop</name>
       <display_name>Set heat pump rated COP (heating)</display_name>
-      <description>[-]</description>
       <type>Double</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -347,12 +346,6 @@ The flexibility of the system is based on user-defined temperatures and times, w
     </attribute>
   </attributes>
   <files>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>CD7F5672</checksum>
-    </file>
     <file>
       <filename>README.md.erb</filename>
       <filetype>erb</filetype>
@@ -371,28 +364,34 @@ The flexibility of the system is based on user-defined temperatures and times, w
       <usage_type>doc</usage_type>
       <checksum>E8326C12</checksum>
     </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>E0468DD6</checksum>
+    </file>
+    <file>
+      <filename>add_hphw_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>15E27276</checksum>
+    </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>E4E50206</checksum>
+      <checksum>1FE9503E</checksum>
     </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
-        <identifier>2.8.0</identifier>
+        <identifier>3.0.0</identifier>
         <min_compatible>2.8.0</min_compatible>
       </version>
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>97C8CF92</checksum>
-    </file>
-    <file>
-      <filename>add_central_hpwh_for_load_flexibility.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>28D79679</checksum>
+      <checksum>F8FEB798</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/{add_central_hpwh_for_load_flexibility/tests/add_central_hpwh_for_load_flexibility.rb → add_hpwh/tests/add_hphw_test.rb}

@@ -41,7 +41,7 @@ require 'minitest/autorun'
 require_relative '../measure.rb'
 require 'fileutils'
 
-class AddCentralHPWHForLoadFlexibilityTest < Minitest::Test
+class AddHphwTest < Minitest::Test
   # def setup
   # end
 
@@ -50,7 +50,7 @@ class AddCentralHPWHForLoadFlexibilityTest < Minitest::Test
 
   def test_good_argument_values
     # create an instance of the measure
-    measure = AddCentralHPWHForLoadFlexibility.new
+    measure = AddHphw.new
 
     # create runner with empty OSW
     osw = OpenStudio::WorkflowJSON.new
@@ -85,12 +85,12 @@ class AddCentralHPWHForLoadFlexibilityTest < Minitest::Test
     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)
 
+    # show the output
+    show_output(result)
+
     # save the model to test output directory
     output_file_path = "#{File.dirname(__FILE__)}//output/test_output.osm"
     model.save(output_file_path, true)

data/lib/measures/add_packaged_ice_storage/LICENSE.md

@@ -0,0 +1,27 @@
+OpenStudio(R), Copyright (c) 2008-2020, 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 HOLDERS AND 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, THE UNITED STATES GOVERNMENT, 
+OR ANY CONTRIBUTORS 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.