openstudio-model-articulation 0.4.0 → 0.6.1

data/lib/measures/create_typical_doe_building_from_model/README.md.erb

@@ -13,9 +13,9 @@
 ## Measure Type
 <%= measureType %>
 
-[//]: # (Commenting out until it works in SDK)
-[//]: # (## Taxonomy)
-[//]: # (<%= taxonomy %>)
+[//]: # (Only finds value if taxonomy method is added to measure.rb, won't read out of measure.xml)
+## Taxonomy
+<%= taxonomy %>
 
 ___
 ## Table of Contents
@@ -36,33 +36,40 @@ While this measure has many arguments, they all have default values so you can s
 
 ## DOE Template and Building Type Mapping
 
-- Templates:
-  - DOE Ref Pre-1980
-  - DOE Ref 1980 - 2004
-  - 90.1-2004
-  - 90.1-2007
-  - 90.1-2010
-  - 90.1-2013
-- Building Types:
-  - SecondarySchool
-  - PrimarySchool
-  - SmallOffice
-  - MediumOffice
-  - LargeOffice
-  - SmallHotel
-  - LargeHotel
-  - Warehouse
-  - RetailStandalone
-  - RetailStripmall
-  - QuickServiceRestaurant
-  - FullServiceRestaurant
-  - MidriseApartment
-  - HighriseApartment
-  - Hospital
-  - Outpatient
-  - SuperMarket
-
-[//]: # (Would be nice to make these lists dynamic from the measure to they don't become outdated)
+#### Templates:
+<% arguments.each do |argument| %>
+<% if argument[:name] == 'template'%>
+<% argument[:choice_display_names].each do |choice|%>
+- <%= choice %><br/>
+<% end %>
+<% end %>
+<% end %>
+
+#### Building Types:
+- SecondarySchool
+- PrimarySchool
+- SmallOffice
+- MediumOffice
+- LargeOffice
+- SmallHotel
+- LargeHotel
+- Warehouse
+- RetailStandalone
+- RetailStripmall
+- QuickServiceRestaurant
+- FullServiceRestaurant
+- MidriseApartment
+- HighriseApartment
+- Hospital
+- Outpatient
+- SuperMarket
+- Laboratory
+- LargeDataCenterLowITE
+- LargeDataCenterHighITE
+- SmallDataCenterLowITE
+- SmallDataCenterHighITE
+
+[//]: # (argument values for template are dynamically generated from current version of the measure. Cannot easily dynamically generate building types since they are not arguments to this measure and are passed in withthe model spaces.)
 
 ## HVAC Configuration Arguments
 
@@ -76,52 +83,56 @@ While this measure has many arguments, they all have default values so you can s
 
 - `Service Water Heating Source`can be set to `Inferred`, `NaturalGas`, `Electricity`, or `HeatPump`.
 
-- `Kitchen Exhaust MakeUp Air Calculation Method` is used to determine if makeup air is modeled for kitchen exhaust and what zone that comes from. While the default choice of `Adajcent` makes sence for custom user geometry, if the geometry was autogenerated without representing an actual plan, you can set makup air to come from the `Largest Zone`. `None` is also an option, which disables makeup air.
+- `Kitchen Exhaust MakeUp Air Calculation Method` is used to determine if makeup air is modeled for kitchen exhaust and what zone that comes from. While the default choice of `Adajcent` makes sense for custom user geometry, if the geometry was autogenerated without representing an actual plan, you can set makeup air to come from the `Largest Zone`. `None` is also an option, which disables makeup air.
 
 ## Exterior Lighting Arguments
 
-- `Exterior Lighting Zone` is used to identify the exterior lighting allowances based on how urban or rural the site for the buidling is. The `Template also impacts the target value.
+- `Exterior Lighting Zone` is used to identify the exterior lighting allowances based on how urban or rural the site for the building is. The `Template also impacts the target value.
 
 - `Onsite Parking Fraction` can reduce or eliminate the amount of exterior lighting for parking added to the model. This wil not reduce exterior facade, walkway, or entry lighting.
 
 ## Bool Arguments to Enable/Disable Elements of This Measure
 
-The following is a list of aruments for elements of the model that can be enabled or disabled for the measure.
+The following is a list of arguments for elements of the model that can be enabled or disabled for the measure.
 - `Add Constructions to Model`
 - `Add Space Type Loads to Model`
-- `Add Elevators to Model`. This will only be added to buildings with more than one story. Number of floors will be used to determine the elevator type, and the number of occpants can determine both the number of elevators and can impact the schedule. To avoid large jumps in parametric analyses, the number of elevators is a double instead of an integer, but will never be less than 1.0 for multi-story buildings, but can for example be 2.6 or 1.5 elevators, instead of just 1 or 2. The logic used isn't depending on a space or space type existing for elevators. The space laod will be added to the largest space on the first story. Fraciton of heat lost will be set to 1.0 for traction elevators.
+- `Add Elevators to Model`. This will only be added to buildings with more than one story. Number of floors will be used to determine the elevator type, and the number of occupants can determine both the number of elevators and can impact the schedule. To avoid large jumps in parametric analyses, the number of elevators is a double instead of an integer, but will never be less than 1.0 for multi-story buildings, but can for example be 2.6 or 1.5 elevators, instead of just 1 or 2. The logic used isn't depending on a space or space type existing for elevators. The space load will be added to the largest space on the first story. Fraction of heat lost will be set to 1.0 for traction elevators.
 - `Add Internal Mass to Model`
 - `Add Exterior Lights to Model`
 - `Add Exhaust Fans to Model`
 - `Add Service Water Heating to Model`
 - `Add Thermostats`
-- `Add HVAC System to Model`. This may add a secondary system for zones with internal loads or schedules that are dis-similar from the typical zones. For thermal zones on the primary zone, where  multi-zone air loops are added, one air loop will be added for each building story. A sizing run will be performed however the elements in the model will stay autosized. The sizing run is to identify the proper target system efficency.
+- `Add HVAC System to Model`. This may add a secondary system for zones with internal loads or schedules that are dis-similar from the typical zones. For thermal zones on the primary zone, where  multi-zone air loops are added, one air loop will be added for each building story. A sizing run will be performed however the elements in the model will stay autosized. The sizing run is to identify the proper target system efficiency.
 - `Add Refrigeration to Model`
 
 ## Hours of Operation Arguments
 
 There are three arguments each for weekday and weekend behavior. In each case there are the following arguments.
 
-- Bool argument to enable/dsiable altering of weekdays or weekends
+- Bool argument to enable/disable altering of weekdays or weekends
 - Operating hours start time
 - Operating hours duration
 
-
 ## Other Arguments
 
-- `Use Upstream Argument Values` can be left at the default value of true for most cases. This argument shows up in a number of measures, and then intent is to enable the synchronization of arguments that may be used as a variable in a parametric study across multiple measures. Generally measure ahve uqniue argument names that don't exist, but some such as `Template` are used frequently. This argument, when set to true, will use the value of `Template` from an earlier measure in the workflow, if found, in place of what is entered as the value for this measure.
+- `Use Upstream Argument Values` can be left at the default value of true for most cases. This argument shows up in a number of measures, and then intent is to enable the synchronization of arguments that may be used as a variable in a parametric study across multiple measures. Generally measures gave unique argument names that don't exist in other measures, but some such as `template` are used frequently. This argument, when set to true, will use the value of `Template` from an earlier measure in the workflow, if found, in place of what is entered as the value for this measure.
 - `Unmet Hours Tolerance` is used to change the tolerance used in EnergyPlus for unmet heating and cooling hours.
-- `Clean Model of non-geometry objects` shoudl be set to false when you have a non-empty model with objects that you want to maintain. If you have split this measure in two the second instance of this should have it set to false or it will overwrite elements made by the earlier measure.
+- `Clean Model of non-geometry objects` should be set to false when you have a non-empty model with objects that you want to maintain. If you have split this measure in two the second instance of this should have it set to false or it will overwrite elements made by the earlier measure.
 - `Enable Daylight Savings` will change daylighting saving to true when enabled.
 
 ## Development Comments
 
-This measure relies on the openstudio-standards gem which is included in the OpenStudio CLI as well as a number of resources files listed below that are contained in the measure's `resources` directory. Other than the arguments almost none of the measure code is in the measure.rb file. The resource files are used by a number of measures and should be udpated from the shared library and not within this measure.
- - os_lib_model_generation.rb
- - os_lib_helper_methods.rb
- - os_lib_helper_methods.rb
+This measure relies on the openstudio-standards gem which is included in the OpenStudio CLI as well as a number of resources files listed below that are contained in the openstudio-extension gem which is also included in the OpenStudio CLI. Other than the arguments almost none of the measure code is in the measure.rb file. The resource files are used by a number of measures and should be updated from the shared library and not within this measure.
+- os_lib_model_generation.rb
+- os_lib_model_simplification.rb
+- os_lib_geometry.rb
+- os_lib_helper_methods.rb
+
+___
 
-*(Automatically generated argument information follows)*## Arguments
+*(Automatically generated argument information follows)*
+
+## Arguments
 
 <% arguments.each do |argument| %>
 ### <%= argument[:display_name] %>
@@ -131,6 +142,9 @@ This measure relies on the openstudio-standards gem which is included in the Ope
 **Units:** <%= argument[:units] %>,
 **Required:** <%= argument[:required] %>,
 **Model Dependent:** <%= argument[:model_dependent] %>
+<% if argument[:type] == "Choice" && !argument[:model_dependent]%>
+**Choice Display Names** <%= argument[:choice_display_names] %>
+<% end %>
 <% end %>
 
 <% if arguments.size == 0 %>

data/lib/measures/create_typical_doe_building_from_model/measure.rb

@@ -41,7 +41,7 @@ require 'openstudio-standards'
 # load OpenStudio measure libraries from openstudio-extension gem
 require 'openstudio-extension'
 require 'openstudio/extension/core/os_lib_helper_methods'
-require 'openstudio/extension/core/os_lib_model_generation.rb'
+require 'openstudio/extension/core/os_lib_model_generation'
 
 require_relative 'resources/Model.hvac' # DLM: should this be in openstudio-standards? dfg some tests fail without it
 
@@ -66,6 +66,11 @@ class CreateTypicalDOEBuildingFromModel < OpenStudio::Measure::ModelMeasure
     return 'It is important that the template argument chosen for this measure is in line with the buding types for the stub space types of the model passed in.'
   end
 
+  # used to populate taxonomy in readme.md
+  def taxonomy
+    return 'Whole Building.Space Types'
+  end
+
   # define the arguments that the user will input
   def arguments(model)
     args = OpenStudio::Measure::OSArgumentVector.new
@@ -80,7 +85,7 @@ class CreateTypicalDOEBuildingFromModel < OpenStudio::Measure::ModelMeasure
     end
 
     # Make argument for template
-    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', get_doe_templates, true)
+    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', get_doe_templates(false), true)
     template.setDisplayName('Target Standard')
     template.setDefaultValue(default_string)
     args << template

data/lib/measures/create_typical_doe_building_from_model/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>create_typical_doe_building_from_model</name>
   <uid>b2c80210-33b3-4dfd-8267-535efd81f552</uid>
-  <version_id>af76adbb-6aea-419e-96ee-81cf11f19ccb</version_id>
-  <version_modified>20210423T142536Z</version_modified>
+  <version_id>bd01bf11-d315-49ed-8c05-3ce269edbc1f</version_id>
+  <version_modified>20220505T182933Z</version_modified>
   <xml_checksum>99E7000D</xml_checksum>
   <class_name>CreateTypicalDOEBuildingFromModel</class_name>
   <display_name>Create Typical DOE Building from Model</display_name>
@@ -1372,52 +1372,52 @@
       <usage_type>test</usage_type>
       <checksum>F22DEFBC</checksum>
     </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>A21A3ED2</checksum>
+    </file>
+    <file>
+      <filename>Model.hvac.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>32C64B0B</checksum>
+    </file>
     <file>
       <filename>README.md.erb</filename>
       <filetype>erb</filetype>
       <usage_type>readmeerb</usage_type>
-      <checksum>46CFB534</checksum>
+      <checksum>BDCE44E6</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>1B1C70D8</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>A21A3ED2</checksum>
-    </file>
-    <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>2.0.0</identifier>
-        <min_compatible>3.0.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>1008A2B9</checksum>
+      <checksum>7F39813C</checksum>
     </file>
     <file>
       <filename>create_typical_doe_building_from_model_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>59AEB6FD</checksum>
+      <checksum>2DF721BA</checksum>
     </file>
     <file>
       <filename>measure_test_hvac.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>188F5F6B</checksum>
+      <checksum>9B04EEB7</checksum>
     </file>
     <file>
-      <filename>Model.hvac.rb</filename>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.0.0</identifier>
+        <min_compatible>3.0.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
       <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>32C64B0B</checksum>
+      <usage_type>script</usage_type>
+      <checksum>72714DCB</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/deer_space_type_and_construction_set_wizard/measure.rb

@@ -49,7 +49,7 @@ class DEERSpaceTypeAndConstructionSetWizard < OpenStudio::Measure::ModelMeasure
   # load OpenStudio measure libraries from openstudio-extension gem
   require 'openstudio-extension'
   require 'openstudio/extension/core/os_lib_helper_methods'
-  require 'openstudio/extension/core/os_lib_model_generation.rb'
+  require 'openstudio/extension/core/os_lib_model_generation'
 
   # resource files used by measure
   include OsLib_HelperMethods

data/lib/measures/deer_space_type_and_construction_set_wizard/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>deer_space_type_and_construction_set_wizard</name>
   <uid>d8effcbd-52b2-4e5c-866c-e85091142aa6</uid>
-  <version_id>745737d5-1816-4dc6-8a95-0059b881b88a</version_id>
-  <version_modified>20210423T142536Z</version_modified>
+  <version_id>ef3a2767-2503-4ef7-97aa-ad2e64a859a4</version_id>
+  <version_modified>20220505T182929Z</version_modified>
   <xml_checksum>A514F332</xml_checksum>
   <class_name>DEERSpaceTypeAndConstructionSetWizard</class_name>
   <display_name>DEER Space Type and Construction Set Wizard</display_name>
@@ -363,7 +363,7 @@
       <filename>deer_space_type_and_construction_set_wizard_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>854655C1</checksum>
+      <checksum>8B39BFC0</checksum>
     </file>
     <file>
       <version>
@@ -374,7 +374,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>D6961EE1</checksum>
+      <checksum>B9BC7D57</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/find_and_replace_in_all_thermal_zone_names/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>find_and_replace_in_all_thermal_zone_names</name>
   <uid>3573d81e-e7de-4949-be50-8abcd0f95a35</uid>
-  <version_id>85da1815-b093-45ef-a399-1c8cc9b46956</version_id>
-  <version_modified>20210423T142537Z</version_modified>
+  <version_id>aa8dce36-46c8-4bd1-a755-e5368218a0c1</version_id>
+  <version_modified>20220505T182935Z</version_modified>
   <xml_checksum>057E8D9D</xml_checksum>
   <class_name>FindAndReplaceInAllThermalZoneNames</class_name>
   <display_name>Find And Replace In All Thermal Zone Names</display_name>
@@ -85,7 +85,7 @@
       <filename>find_and_replace_in_all_thermal_zone_names_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>5EF10DDA</checksum>
+      <checksum>1ACD900C</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/make_shading_surfaces_based_on_zone_multipliers/measure.rb

@@ -132,6 +132,7 @@ class MakeShadingSurfacesBasedOnZoneMultipliers < OpenStudio::Measure::ModelMeas
 
           space.surfaces.each do |surface|
             next if surface.outsideBoundaryCondition != 'Outdoors'
+
             surfaces_to_copy[surface] = multiplier
 
             # store  vertices
@@ -157,6 +158,7 @@ class MakeShadingSurfacesBasedOnZoneMultipliers < OpenStudio::Measure::ModelMeas
 
           space.surfaces.each do |surface|
             next if surface.outsideBoundaryCondition != 'Outdoors'
+
             surfaces_to_copy[surface] = multiplier
 
             # store  vertices

data/lib/measures/make_shading_surfaces_based_on_zone_multipliers/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>make_shading_surfaces_based_on_zone_multipliers</name>
   <uid>57d7314d-2ff0-4c13-bf07-b63380bfdea6</uid>
-  <version_id>280fcc05-b5d1-4f95-9bc3-f0a426fa1a1f</version_id>
-  <version_modified>20210423T142537Z</version_modified>
+  <version_id>b6f2e9fb-355d-4e3d-acee-3ec908d95ef3</version_id>
+  <version_modified>20220505T182926Z</version_modified>
   <xml_checksum>2AF3A68E</xml_checksum>
   <class_name>MakeShadingSurfacesBasedOnZoneMultipliers</class_name>
   <display_name>Make Shading Surfaces Based on Zone Multipliers</display_name>
@@ -97,13 +97,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>2A4A98D5</checksum>
+      <checksum>5DEA693D</checksum>
     </file>
     <file>
       <filename>make_shading_surfaces_based_on_zone_multipliers_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>E7C200C9</checksum>
+      <checksum>E4A4E702</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/merge_floorspace_js_with_model/measure.rb

@@ -143,12 +143,14 @@ class MergeFloorspaceJsWithModel < OpenStudio::Measure::ModelMeasure
       fixed = false
       vertices.each do |vertex|
         next if fixed
+
         if array.include?(vertex)
           # create a new set of vertices
           new_vertices = OpenStudio::Point3dVector.new
           array_b = []
           surface.vertices.each do |vertex_b|
             next if array_b.include?(vertex_b)
+
             new_vertices << vertex_b
             array_b << vertex_b
           end
@@ -184,6 +186,7 @@ class MergeFloorspaceJsWithModel < OpenStudio::Measure::ModelMeasure
 
         surfaces_b.each do |surface_b|
           next if surface_a == surface_b # dont' test against same surface
+
           if surface_a.equalVertices(surface_b)
             runner.registerWarning("#{surface_a.name} and #{surface_b.name} in #{space.name} have duplicate geometry, removing #{surface_b.name}.")
             surface_b.remove
@@ -221,7 +224,7 @@ class MergeFloorspaceJsWithModel < OpenStudio::Measure::ModelMeasure
     json = JSON.parse(File.read(path.get.to_s))
 
     # error checking
-    unless !json['space_types'].empty?
+    if json['space_types'].empty?
       runner.registerInfo('No space types were created.')
     end
 

data/lib/measures/merge_floorspace_js_with_model/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>merge_floorspace_js_with_model</name>
   <uid>16ef6369-6420-4f17-894c-a767895bcaa4</uid>
-  <version_id>cd8c6e2c-6e2b-45d3-a9a2-aaccb5dd38a9</version_id>
-  <version_modified>20210423T142537Z</version_modified>
+  <version_id>e9c8d42e-69b7-4d09-9cf8-9090ce62e4e2</version_id>
+  <version_modified>20220505T182931Z</version_modified>
   <xml_checksum>0AD1E2E2</xml_checksum>
   <class_name>MergeFloorspaceJsWithModel</class_name>
   <display_name>Merge FloorspaceJs with Model</display_name>
@@ -98,13 +98,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>B66DBC8C</checksum>
+      <checksum>66A3D44B</checksum>
     </file>
     <file>
       <filename>merge_floorspace_js_with_model_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>33A937E8</checksum>
+      <checksum>F51D04E3</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/merge_spaces_from_external_file/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>merge_spaces_from_external_file</name>
   <uid>e439a1a9-d075-4a25-9f83-2dca79d2826e</uid>
-  <version_id>d727f4c4-a1b5-485f-8ed0-984dc2083fc0</version_id>
-  <version_modified>20210423T142538Z</version_modified>
+  <version_id>407db88d-c74e-4220-b538-cd528b293e2e</version_id>
+  <version_modified>20220505T182935Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>MergeSpacesFromExternalFile</class_name>
   <display_name>Merge Spaces from External File</display_name>
@@ -238,7 +238,7 @@
       <filename>merge_spaces_from_external_file_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>9AAAEDBF</checksum>
+      <checksum>2D93C8DF</checksum>
     </file>
   </files>
 </measure>