openstudio-load-flexibility-measures 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3067d071796cf31183292010668e79ad8f434cc5affc3cdb991d9fa79afb5a07
-  data.tar.gz: 445adcf8663134e60fe14eb8d50104920eab3703e11ebd73e6f12782f716748b
+  metadata.gz: bab354da71f81f20c47dcdda629965c11ea7fc402f09b6383f3e22292a461ec2
+  data.tar.gz: dddc55254365477fc787866d3fa3298b4136f6fc38a15b5ef7dc3418b6887420
 SHA512:
-  metadata.gz: 9c62fbf8957c40e177a11148e344c4bb357bc2ab84256842166596bfb6676208500f5d58ca0be8267f70fdd0866a5694b1ee5a8576a8d4dc6d0fbe053900717a
-  data.tar.gz: 99bccbd7f9c5400c53ee041394f921fd9a10bae81f9ca8bd6caadcd91fa44009b958dcabb556cda9ed149d481272c84539b883674687fca62d9dee6028542767
+  metadata.gz: 0dd68836c8e62800b7a2ef544e0ce067a08e39184a826763aaf2d2672f8d272e6ebb232f10f98945fd06074b43cbd71c484ec8100122dcc5a38c315e1acb2cf0
+  data.tar.gz: a7ade7e07aff4b029abc28c8d0ebf8cfb0eb25cdae4de8696f3287fe9779eed7fb98db256edbbe0d2f51b0f8dd76758850b809aa3b4f2ab9a67e06cb0ea722ae

data/CHANGELOG.md

@@ -1,11 +1,20 @@
 # OpenStudio Load Flexibility Measures Gem
 
+## Version 0.1.3
+
+* Measures have been renamed and readme updated:
+  * "Add Ice Storage to Plant Loop for Load Flexibility" is now "Add Central Ice Storage"
+  * "Add Distributed Ice Storage to Air Loop for Load Flexibility" is now "Add Packaged Ice Storage"
+  * "Add Central HPHW for Load Flexibility" is now "Add HPHW"
+* Bug Fixes:
+  * [#12](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/12), File names become too long when using with URBANopt CLI
+
 ## Version 0.1.2
 
 * Bug Fixes:
-  * ![Fixed:][fixed] [#4](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/4), use unix paths in 'add_distributed_ice_storage_to_air_loop_for_load_flexibility'
-  * ![Fixed:][fixed] [#6](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/6), code error in add_distributed measure
-  * ![Fixed:][fixed] [#8](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/8), EMS output variables cause measure failure
+  * [#4](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/4), use unix paths in 'add_distributed_ice_storage_to_air_loop_for_load_flexibility'
+  * [#6](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/6), code error in add_distributed measure
+  * [#8](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/8), EMS output variables cause measure failure
 * Remove .DS_Store and exclude from future releases
 * Code cleanup
 

data/README.md

@@ -21,9 +21,9 @@ Or install it yourself as:
 ## Usage
 
 The openstudio-load-flexibility-measures gem contains measures to apply thermal load flexibility to a building model. The current version contains the following:
-* Add Central HPWH for Load Flexibility
-* Add Distributed Ice Storage to Air Loop for Load Flexibility
-* Add Ice Storage to Plant Loop for Load Flexibility
+* Add HPHW (Heat Pump Hot Water Heater)
+* Add Central Ice Storage (for plant loops)
+* Add Packaged Ice Storage (for rooftop units)
 
 Detailed instructions for usage are included in each measure's respective README.md and docs folder. 
 
@@ -40,3 +40,4 @@ Detailed instructions for usage are included in each measure's respective README
 ## TODO
 
 - [ ] Update usage with links to respective measure documentation
+- [ ] Update documentation pdf's to reflect revised measure names

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

@@ -49,7 +49,7 @@
 require "#{File.dirname(__FILE__)}/resources/OsLib_Schedules"
 
 # start the measure
-class AddIceStorageToPlantLoopForLoadFlexibility < OpenStudio::Measure::ModelMeasure
+class AddCentralIceStorage < OpenStudio::Measure::ModelMeasure
   # human readable name
   def name
     # Measure name should be the title case of the class name.
@@ -1321,4 +1321,4 @@ class AddIceStorageToPlantLoopForLoadFlexibility < OpenStudio::Measure::ModelMea
 end
 
 # register the measure to be used by the application
-AddIceStorageToPlantLoopForLoadFlexibility.new.registerWithApplication
+AddCentralIceStorage.new.registerWithApplication

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

@@ -1,12 +1,12 @@
 <?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>7c7e99fa-5fa6-403b-98d2-d08a19e2dba2</version_id>
-  <version_modified>20200806T183852Z</version_modified>
+  <version_id>8b813d27-6c3b-4b60-8004-c0bcfee01b24</version_id>
+  <version_modified>20200903T163027Z</version_modified>
   <xml_checksum>6394841D</xml_checksum>
-  <class_name>AddIceStorageToPlantLoopForLoadFlexibility</class_name>
+  <class_name>AddCentralIceStorage</class_name>
   <display_name>Add Ice Storage Tank</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>
@@ -477,10 +477,10 @@
       <checksum>E0468DD6</checksum>
     </file>
     <file>
-      <filename>add_ice_storage_to_plant_loop_for_load_flexibility_test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>4CDCF2D8</checksum>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>69EDB2DB</checksum>
     </file>
     <file>
       <version>
@@ -491,13 +491,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>32CD91EE</checksum>
+      <checksum>914DA2C8</checksum>
     </file>
     <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>69EDB2DB</checksum>
+      <filename>add_central_ice_storage_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>8738374B</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

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

@@ -43,7 +43,7 @@
 # EnergyPlus Engineering Reference, Sections:
 
 # start the measure
-class AddCentralHpwhForLoadFlexibility < OpenStudio::Measure::ModelMeasure
+class AddHphw < OpenStudio::Measure::ModelMeasure
   require 'openstudio-standards'
 
   # human readable name
@@ -644,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,12 +1,12 @@
 <?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>5be8272a-251e-4e96-8e32-cded6decab33</version_id>
-  <version_modified>20200806T183852Z</version_modified>
+  <version_id>80211a9e-15ad-4f6a-9090-795ecb416c5e</version_id>
+  <version_modified>20200903T163041Z</version_modified>
   <xml_checksum>A374667A</xml_checksum>
-  <class_name>AddCentralHpwhForLoadFlexibility</class_name>
+  <class_name>AddHphw</class_name>
   <display_name>flexible_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. 
@@ -371,10 +371,10 @@ The flexibility of the system is based on user-defined temperatures and times, w
       <checksum>E0468DD6</checksum>
     </file>
     <file>
-      <filename>add_central_hpwh_for_load_flexibility.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>349A48C2</checksum>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>48EE62B0</checksum>
     </file>
     <file>
       <version>
@@ -385,13 +385,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>3E6F88C9</checksum>
+      <checksum>930296F3</checksum>
     </file>
     <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>48EE62B0</checksum>
+      <filename>add_hphw.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>15E27276</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.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

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

@@ -37,7 +37,7 @@
 # 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'
@@ -687,4 +687,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,12 +1,12 @@
 <?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>db67a99f-13f3-4084-ab3f-548cfb8c32a5</version_id>
+  <version_modified>20200903T163041Z</version_modified>
   <xml_checksum>2617824F</xml_checksum>
-  <class_name>AddDistributedIceStorageToAirLoopForLoadFlexibility</class_name>
+  <class_name>AddPackagedIceStorage</class_name>
   <display_name>Add Distributed Ice Storage to Air Loop for Load Flexibility</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.
@@ -232,12 +232,6 @@ If 'AutoSize' is selected for ice capacity, these inputs set an ice capacity siz
       <usage_type>license</usage_type>
       <checksum>E0468DD6</checksum>
     </file>
-    <file>
-      <filename>add_distributed_ice_storage_to_air_loop_for_load_flexibility_test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>FC11EAC7</checksum>
-    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -247,7 +241,13 @@ 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>C1C62C47</checksum>
+    </file>
+    <file>
+      <filename>add_packaged_ice_storage_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>2D918464</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.1.3'.freeze
   end
 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.1.3
 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: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,33 +114,30 @@ 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.rb
+- lib/measures/add_packaged_ice_storage/LICENSE.md
+- 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