Merge pull request #152 from NREL/develop

Version 0.11.1
NREL · Jan 13, 2025 · a0628dc · a0628dc
2 parents 47b7fa6 + 2fda610
commit a0628dc
Show file tree

Hide file tree

Showing 19 changed files with 68 additions and 65 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # OpenStudio Model Articulation Gems
 
+## Version 0.11.1
+* Update 'story_multiplier' argument to 'story_multiplier_method' for create_bar_from_building_type_ratios measure
+* Update dependencies for 3.9
+
 ## Version 0.11.0
 * Support for OpenStudio 3.9 (upgrade to standards gem 0.7.0, extension gem 0.8.1)
 * Fixed [#129]( https://github.com/NREL/openstudio-model-articulation-gem/issues/129 ), Radiance measure needs to be updated for new E+ output variable

diff --git a/Gemfile b/Gemfile
@@ -19,8 +19,8 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # gem 'bcl', :git => 'https://github.com/wenyikuang/bcl-gem.git', :branch => 'develop'
 
 # Only uncomment if you need to test a different version of the extension gem
-if allow_local && File.exist?('../OpenStudio-extension-gem')
-  gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
-elsif allow_local
-  gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
-end
+# if allow_local && File.exist?('../OpenStudio-extension-gem')
+#   gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
+# elsif allow_local
+#   gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
+# end
diff --git a/lib/measures/create_bar_from_building_type_ratios/README.md b/lib/measures/create_bar_from_building_type_ratios/README.md
@@ -584,7 +584,7 @@ This should be true unless you are modeling a partial building which doesn't inc
 
 ### Calculation Method for Story Multiplier
 
-**Name:** story_multiplier,
+**Name:** story_multiplier_method,
 **Type:** Choice,
 **Units:** ,
 **Required:** true,

diff --git a/lib/measures/create_bar_from_building_type_ratios/measure.rb b/lib/measures/create_bar_from_building_type_ratios/measure.rb
@@ -341,15 +341,15 @@ def arguments(model)
     top_story_exterior_exposed_roof.setDefaultValue(true)
     args << top_story_exterior_exposed_roof
 
-    # Make argument for story_multiplier
+    # Make argument for story_multiplier_method
     choices = OpenStudio::StringVector.new
     choices << 'None'
     choices << 'Basements Ground Mid Top'
     # choices << "Basements Ground Midx5 Top"
-    story_multiplier = OpenStudio::Measure::OSArgument.makeChoiceArgument('story_multiplier', choices, true)
-    story_multiplier.setDisplayName('Calculation Method for Story Multiplier')
-    story_multiplier.setDefaultValue('Basements Ground Mid Top')
-    args << story_multiplier
+    story_multiplier_method = OpenStudio::Measure::OSArgument.makeChoiceArgument('story_multiplier_method', choices, true)
+    story_multiplier_method.setDisplayName('Calculation Method for Story Multiplier')
+    story_multiplier_method.setDefaultValue('Basements Ground Mid Top')
+    args << story_multiplier_method
 
     # make an argument for make_mid_story_surfaces_adiabatic (added to avoid issues with intersect and to lower surface count when using individual stories sliced)
     make_mid_story_surfaces_adiabatic = OpenStudio::Measure::OSArgument.makeBoolArgument('make_mid_story_surfaces_adiabatic', true)

diff --git a/lib/measures/create_bar_from_building_type_ratios/measure.xml b/lib/measures/create_bar_from_building_type_ratios/measure.xml
@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>create_bar_from_building_type_ratios</name>
   <uid>6e3a14f8-c3c7-4e03-bc51-bef8a52e1a05</uid>
-  <version_id>89c35873-5698-4e69-81a9-b7781fd3965e</version_id>
-  <version_modified>2024-11-16T23:56:32Z</version_modified>
+  <version_id>53acfac0-33c0-4f7f-9cd1-45ee9b483507</version_id>
+  <version_modified>2025-01-09T08:07:48Z</version_modified>
   <xml_checksum>2AF3A68E</xml_checksum>
   <class_name>CreateBarFromBuildingTypeRatios</class_name>
   <display_name>Create Bar From Building Type Ratios</display_name>
@@ -1199,7 +1199,7 @@
       </choices>
     </argument>
     <argument>
-      <name>story_multiplier</name>
+      <name>story_multiplier_method</name>
       <display_name>Calculation Method for Story Multiplier</display_name>
       <type>Choice</type>
       <required>true</required>
@@ -1353,7 +1353,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>9AB9F376</checksum>
+      <checksum>5E1C4DB0</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -1496,13 +1496,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>153D5528</checksum>
+      <checksum>0DE63CCC</checksum>
     </file>
     <file>
       <filename>create_bar_from_building_type_ratios_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>2E1610BC</checksum>
+      <checksum>CD016F6B</checksum>
     </file>
     <file>
       <filename>example_model.osm</filename>

diff --git a/...s/create_bar_from_building_type_ratios/tests/create_bar_from_building_type_ratios_test.rb b/...s/create_bar_from_building_type_ratios/tests/create_bar_from_building_type_ratios_test.rb
@@ -78,7 +78,7 @@ def test_no_multiplier
     args = {}
     args['total_bldg_floor_area'] = 50000.0
     args['num_stories_above_grade'] = 5
-    args['story_multiplier'] = 'None'
+    args['story_multiplier_method'] = 'None'
 
     apply_measure_to_model(__method__.to_s.gsub('test_', ''), args, 'example_model.osm')
   end
@@ -1031,7 +1031,7 @@ def test_custom_offset
     args['building_rotation'] = 0
     args['make_mid_story_surfaces_adiabatic'] = true
     args['bar_sep_dist_mult'] = 3
-    args['story_multiplier'] = 'None'
+    args['story_multiplier_method'] = 'None'
     args['num_stories_below_grade'] = 0
     args['bar_width'] = 60.0
 
@@ -1053,7 +1053,7 @@ def test_custom_offset_alt
     args['building_rotation'] = 0
     args['make_mid_story_surfaces_adiabatic'] = true
     args['bar_sep_dist_mult'] = 3
-    # args['story_multiplier'] = 'None'
+    # args['story_multiplier_method'] = 'None'
     # args['num_stories_below_grade'] = 1
     # args['party_wall_stories_south'] = 1
     # args['party_wall_stories_east'] = 2
@@ -1077,12 +1077,12 @@ def test_custom_offset_alt2
     args['building_rotation'] = 0
     args['make_mid_story_surfaces_adiabatic'] = true
     args['bar_sep_dist_mult'] = 3
-    # args['story_multiplier'] = 'None'
+    # args['story_multiplier_method'] = 'None'
     # args['num_stories_below_grade'] = 1
     # args['party_wall_stories_south'] = 1
     # args['party_wall_stories_east'] = 2
     args['space_type_sort_logic'] = 'Size'
-    # args['story_multiplier'] = "None"
+    # args['story_multiplier_method'] = "None"
 
     apply_measure_to_model(__method__.to_s.gsub('test_', ''), args, nil, nil, nil)
   end

diff --git a/lib/measures/create_bar_from_deer_building_type_ratios/README.md b/lib/measures/create_bar_from_deer_building_type_ratios/README.md
@@ -684,7 +684,7 @@ This should be true unless you are modeling a partial building which doesn't inc
 
 ### Calculation Method for Story Multiplier
 
-**Name:** story_multiplier,
+**Name:** story_multiplier_method,
 **Type:** Choice,
 **Units:** ,
 **Required:** true,

diff --git a/lib/measures/create_bar_from_deer_building_type_ratios/measure.rb b/lib/measures/create_bar_from_deer_building_type_ratios/measure.rb
@@ -313,15 +313,15 @@ def arguments(model)
     top_story_exterior_exposed_roof.setDefaultValue(true)
     args << top_story_exterior_exposed_roof
 
-    # Make argument for story_multiplier
+    # Make argument for story_multiplier_method
     choices = OpenStudio::StringVector.new
     choices << 'None'
     choices << 'Basements Ground Mid Top'
     # choices << "Basements Ground Midx5 Top"
-    story_multiplier = OpenStudio::Measure::OSArgument.makeChoiceArgument('story_multiplier', choices, true)
-    story_multiplier.setDisplayName('Calculation Method for Story Multiplier')
-    story_multiplier.setDefaultValue('Basements Ground Mid Top')
-    args << story_multiplier
+    story_multiplier_method = OpenStudio::Measure::OSArgument.makeChoiceArgument('story_multiplier_method', choices, true)
+    story_multiplier_method.setDisplayName('Calculation Method for Story Multiplier')
+    story_multiplier_method.setDefaultValue('Basements Ground Mid Top')
+    args << story_multiplier_method
 
     # make an argument for make_mid_story_surfaces_adiabatic (added to avoid issues with intersect and to lower surface count when using individual stories sliced)
     make_mid_story_surfaces_adiabatic = OpenStudio::Measure::OSArgument.makeBoolArgument('make_mid_story_surfaces_adiabatic', true)

diff --git a/lib/measures/create_bar_from_deer_building_type_ratios/measure.xml b/lib/measures/create_bar_from_deer_building_type_ratios/measure.xml
@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>create_bar_from_deer_building_type_ratios</name>
   <uid>aa4a7ecf-5bfd-4c5e-b0ca-e68babbacff1</uid>
-  <version_id>deff6402-221d-44c9-ad2c-a6612604e237</version_id>
-  <version_modified>2024-11-16T23:56:36Z</version_modified>
+  <version_id>0b3bb574-a085-4309-b4b5-102ef23d7477</version_id>
+  <version_modified>2025-01-09T08:07:51Z</version_modified>
   <xml_checksum>B31F0C1F</xml_checksum>
   <class_name>CreateBarFromDEERBuildingTypeRatios</class_name>
   <display_name>Create Bar From DEER Building Type Ratios</display_name>
@@ -823,7 +823,7 @@
       </choices>
     </argument>
     <argument>
-      <name>story_multiplier</name>
+      <name>story_multiplier_method</name>
       <display_name>Calculation Method for Story Multiplier</display_name>
       <type>Choice</type>
       <required>true</required>
@@ -988,7 +988,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>38647660</checksum>
+      <checksum>954998A9</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -1131,7 +1131,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>DC57753C</checksum>
+      <checksum>3927215A</checksum>
     </file>
     <file>
       <filename>create_bar_from_deer_building_type_ratios_test.rb</filename>

diff --git a/lib/measures/create_bar_from_doe_building_type_ratios/README.md b/lib/measures/create_bar_from_doe_building_type_ratios/README.md
@@ -673,7 +673,7 @@ This should be true unless you are modeling a partial building which doesn't inc
 
 ### Calculation Method for Story Multiplier
 
-**Name:** story_multiplier,
+**Name:** story_multiplier_method,
 **Type:** Choice,
 **Units:** ,
 **Required:** true,

diff --git a/lib/measures/create_bar_from_doe_building_type_ratios/measure.rb b/lib/measures/create_bar_from_doe_building_type_ratios/measure.rb
@@ -314,15 +314,15 @@ def arguments(model)
     top_story_exterior_exposed_roof.setDefaultValue(true)
     args << top_story_exterior_exposed_roof
 
-    # Make argument for story_multiplier
+    # Make argument for story_multiplier_method
     choices = OpenStudio::StringVector.new
     choices << 'None'
     choices << 'Basements Ground Mid Top'
     # choices << "Basements Ground Midx5 Top"
-    story_multiplier = OpenStudio::Measure::OSArgument.makeChoiceArgument('story_multiplier', choices, true)
-    story_multiplier.setDisplayName('Calculation Method for Story Multiplier')
-    story_multiplier.setDefaultValue('Basements Ground Mid Top')
-    args << story_multiplier
+    story_multiplier_method = OpenStudio::Measure::OSArgument.makeChoiceArgument('story_multiplier_method', choices, true)
+    story_multiplier_method.setDisplayName('Calculation Method for Story Multiplier')
+    story_multiplier_method.setDefaultValue('Basements Ground Mid Top')
+    args << story_multiplier_method
 
     # make an argument for make_mid_story_surfaces_adiabatic (added to avoid issues with intersect and to lower surface count when using individual stories sliced)
     make_mid_story_surfaces_adiabatic = OpenStudio::Measure::OSArgument.makeBoolArgument('make_mid_story_surfaces_adiabatic', true)

diff --git a/lib/measures/create_bar_from_doe_building_type_ratios/measure.xml b/lib/measures/create_bar_from_doe_building_type_ratios/measure.xml
@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>create_bar_from_doe_building_type_ratios</name>
   <uid>0de3cff9-c805-42c4-964e-18cb43a22c63</uid>
-  <version_id>21d5e86d-8249-48df-8e5f-ec726ccce137</version_id>
-  <version_modified>2024-11-16T23:56:37Z</version_modified>
+  <version_id>a0381b1d-0db5-41fd-b51c-f03e3afd035c</version_id>
+  <version_modified>2025-01-09T08:07:51Z</version_modified>
   <xml_checksum>5F523097</xml_checksum>
   <class_name>CreateBarFromDOEBuildingTypeRatios</class_name>
   <display_name>Create Bar From DOE Building Type Ratios</display_name>
@@ -759,7 +759,7 @@
       </choices>
     </argument>
     <argument>
-      <name>story_multiplier</name>
+      <name>story_multiplier_method</name>
       <display_name>Calculation Method for Story Multiplier</display_name>
       <type>Choice</type>
       <required>true</required>
@@ -928,7 +928,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>B96F2633</checksum>
+      <checksum>BEEE10DB</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -1071,13 +1071,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>AF357BC7</checksum>
+      <checksum>CCC0C7D4</checksum>
     </file>
     <file>
       <filename>create_bar_from_doe_building_type_ratios_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>7286FEA7</checksum>
+      <checksum>A08A5602</checksum>
     </file>
     <file>
       <filename>example_model.osm</filename>

diff --git a/..._bar_from_doe_building_type_ratios/tests/create_bar_from_doe_building_type_ratios_test.rb b/..._bar_from_doe_building_type_ratios/tests/create_bar_from_doe_building_type_ratios_test.rb
@@ -78,7 +78,7 @@ def test_no_multiplier
     args = {}
     args['total_bldg_floor_area'] = 50000.0
     args['num_stories_above_grade'] = 5
-    args['story_multiplier'] = 'None'
+    args['story_multiplier_method'] = 'None'
 
     apply_measure_to_model(__method__.to_s.gsub('test_', ''), args, 'example_model.osm')
   end

diff --git a/lib/measures/create_bar_from_space_type_ratios/README.md b/lib/measures/create_bar_from_space_type_ratios/README.md
@@ -491,7 +491,7 @@ This should be true unless you are modeling a partial building which doesn't inc
 
 ### Calculation Method for Story Multiplier
 
-**Name:** story_multiplier,
+**Name:** story_multiplier_method,
 **Type:** Choice,
 **Units:** ,
 **Required:** true,

diff --git a/lib/measures/create_bar_from_space_type_ratios/measure.rb b/lib/measures/create_bar_from_space_type_ratios/measure.rb
@@ -262,15 +262,15 @@ def arguments(model)
     top_story_exterior_exposed_roof.setDefaultValue(true)
     args << top_story_exterior_exposed_roof
 
-    # Make argument for story_multiplier
+    # Make argument for story_multiplier_method
     choices = OpenStudio::StringVector.new
     choices << 'None'
     choices << 'Basements Ground Mid Top'
     # choices << "Basements Ground Midx5 Top"
-    story_multiplier = OpenStudio::Measure::OSArgument.makeChoiceArgument('story_multiplier', choices, true)
-    story_multiplier.setDisplayName('Calculation Method for Story Multiplier')
-    story_multiplier.setDefaultValue('Basements Ground Mid Top')
-    args << story_multiplier
+    story_multiplier_method = OpenStudio::Measure::OSArgument.makeChoiceArgument('story_multiplier_method', choices, true)
+    story_multiplier_method.setDisplayName('Calculation Method for Story Multiplier')
+    story_multiplier_method.setDefaultValue('Basements Ground Mid Top')
+    args << story_multiplier_method
 
     # make an argument for make_mid_story_surfaces_adiabatic (added to avoid issues with intersect and to lower surface count when using individual stories sliced)
     make_mid_story_surfaces_adiabatic = OpenStudio::Measure::OSArgument.makeBoolArgument('make_mid_story_surfaces_adiabatic', true)

diff --git a/lib/measures/create_bar_from_space_type_ratios/measure.xml b/lib/measures/create_bar_from_space_type_ratios/measure.xml
@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>create_bar_from_space_type_ratios</name>
   <uid>3e988765-9673-46f8-9b65-99d5b86c2b22</uid>
-  <version_id>3220d2d2-1d1b-465c-92ba-bd0fa5ea83d8</version_id>
-  <version_modified>2024-11-16T23:56:38Z</version_modified>
+  <version_id>b03d451a-d0af-44c5-baf6-d5e91af68e2e</version_id>
+  <version_modified>2025-01-09T08:07:51Z</version_modified>
   <xml_checksum>49BEF039</xml_checksum>
   <class_name>CreateBarFromSpaceTypeRatios</class_name>
   <display_name>Create Bar From Space Type Ratios</display_name>
@@ -427,7 +427,7 @@
       </choices>
     </argument>
     <argument>
-      <name>story_multiplier</name>
+      <name>story_multiplier_method</name>
       <display_name>Calculation Method for Story Multiplier</display_name>
       <type>Choice</type>
       <required>true</required>
@@ -581,7 +581,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>6BF1D1B6</checksum>
+      <checksum>8E3C144C</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -724,13 +724,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>57CFCE32</checksum>
+      <checksum>9EFE7662</checksum>
     </file>
     <file>
       <filename>create_bar_from_space_type_ratios_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>0A68D7F4</checksum>
+      <checksum>C1493A39</checksum>
     </file>
   </files>
 </measure>
diff --git a/...easures/create_bar_from_space_type_ratios/tests/create_bar_from_space_type_ratios_test.rb b/...easures/create_bar_from_space_type_ratios/tests/create_bar_from_space_type_ratios_test.rb
@@ -136,9 +136,9 @@ def test_custom_a
     args['building_rotation'] = 0
     args['make_mid_story_surfaces_adiabatic'] = true
     args['bar_sep_dist_mult'] = 3
-    args['story_multiplier'] = 'None'
+    args['story_multiplier_method'] = 'None'
     args['space_type_sort_logic'] = 'Building Type > Size'
-    args['story_multiplier'] = 'None'
+    args['story_multiplier_method'] = 'None'
 
     apply_measure_to_model(__method__.to_s.gsub('test_', ''), args, nil, nil, nil)
   end

diff --git a/lib/openstudio/model_articulation/version.rb b/lib/openstudio/model_articulation/version.rb
@@ -5,6 +5,6 @@
 
 module OpenStudio
   module ModelArticulation
-    VERSION = '0.11.0'
+    VERSION = '0.11.1'
   end
 end