openstudio-model-articulation 0.3.1 → 0.6.0

data/lib/measures/create_typical_deer_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,48 +36,46 @@ While this measure has many arguments, they all have default values so you can s
 
 ## DEER Template and Building Type Mapping
 
-- Templates:
-  - DEER Pre-1975
-  - DEER 1985
-  - DEER 1996
-  - DEER 2003
-  - DEER 2007
-  - DEER 2011
-  - DEER 2014
-  - DEER 2015
-  - DEER 2017
-  - DEER 2020
-- Building Types:
-  - Asm
-  - DMo
-  - ECC
-  - EPr
-  - ERC
-  - ESe
-  - EUn
-  - GHs
-  - Gro
-  - Hsp
-  - Htl
-  - MBT
-  - MFm
-  - MLI
-  - Mtl
-  - Nrs
-  - OfL
-  - OfS
-  - RFF
-  - RSD
-  - Rt3
-  - RtL
-  - RtS
-  - SCn
-  - SFm
-  - SUn
-  - WRf
+#### Templates:
+<% arguments.each do |argument| %>
+<% if argument[:name] == 'template'%>
+<% argument[:choice_display_names].each do |choice|%>
+- <%= choice %><br/>
+<% end %>
+<% end %>
+<% end %>
+
+#### Building Types:
+- Asm
+- DMo
+- ECC
+- EPr
+- ERC
+- ESe
+- EUn
+- GHs
+- Gro
+- Hsp
+- Htl
+- MBT
+- MFm
+- MLI
+- Mtl
+- Nrs
+- OfL
+- OfS
+- RFF
+- RSD
+- Rt3
+- RtL
+- RtS
+- SCn
+- SFm
+- SUn
+- WRf
 
 [//]: # (Provide link to map DEER abbreviation to full building type name)
-[//]: # (Would be nice to make these lists dynamic from the measure to they don't become outdated)
+[//]: # (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
 
@@ -101,16 +99,16 @@ While this measure has many arguments, they all have default values so you can s
 
 ## 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
@@ -124,19 +122,22 @@ There are three arguments each for weekday and weekend behavior. In each case th
 
 ## 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)*
 
-*(Automatically generated argument information follows)*## Arguments
+## Arguments
 
 <% arguments.each do |argument| %>
 ### <%= argument[:display_name] %>
@@ -146,6 +147,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_deer_building_from_model/measure.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, 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:
@@ -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 CreateTypicalDEERBuildingFromModel < 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 CreateTypicalDEERBuildingFromModel < OpenStudio::Measure::ModelMeasure
     end
 
     # Make argument for template
-    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', get_deer_templates, true)
+    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', get_deer_templates(false), true)
     template.setDisplayName('Target Standard')
     template.setDefaultValue(default_string)
     args << template

data/lib/measures/create_typical_deer_building_from_model/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>create_typical_deer_building_from_model</name>
   <uid>09cc23db-5e9b-4b11-b167-1852a15ed339</uid>
-  <version_id>8429e1aa-3ac6-4cdf-8d58-b998699579a9</version_id>
-  <version_modified>20200911T195820Z</version_modified>
+  <version_id>f8a8e7e4-350b-4b0f-a27a-18e1ddf170fd</version_id>
+  <version_modified>20220505T182935Z</version_modified>
   <xml_checksum>AABAC479</xml_checksum>
   <class_name>CreateTypicalDEERBuildingFromModel</class_name>
   <display_name>Create Typical DEER Building from Model</display_name>
@@ -1375,52 +1375,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>53889CE0</checksum>
+      <checksum>DD4698D3</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>D51CAE96</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>E0468DD6</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>B6303750</checksum>
+      <checksum>1B2E71EB</checksum>
     </file>
     <file>
       <filename>measure_test_hvac.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>9185BFA7</checksum>
+      <checksum>3FE8544B</checksum>
     </file>
     <file>
       <filename>create_typical_deer_building_from_model_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>6B02F7C5</checksum>
+      <checksum>B3C5409D</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>D8BF0815</checksum>
+      <usage_type>script</usage_type>
+      <checksum>088F9AFB</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/create_typical_deer_building_from_model/resources/Model.hvac.rb

@@ -1,5 +1,8 @@
+# ComStock™, Copyright (c) 2020 Alliance for Sustainable Energy, LLC. All rights reserved.
+# See top level LICENSE.txt file for license terms.
+
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, 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:
@@ -279,7 +282,7 @@ class OpenStudio::Model::Model
                                      chilled_water_loop_cooling_type: 'AirCooled')
 
     when 'Fan coil district chilled water with boiler'
-      standard.model_add_hvac_system(self, 'Fan Coil ', ht = 'NaturalGas', znht = nil, cl = 'DistrictCooling', zones)
+      standard.model_add_hvac_system(self, 'Fan Coil', ht = 'NaturalGas', znht = nil, cl = 'DistrictCooling', zones)
 
     when 'Fan coil district chilled water with central air source heat pump'
       standard.model_add_hvac_system(self, 'Fan Coil', ht = 'AirSourceHeatPump', znht = nil, cl = 'DistrictCooling', zones)
@@ -494,7 +497,7 @@ class OpenStudio::Model::Model
     when 'VAV chiller with gas boiler reheat'
       standard.model_add_hvac_system(self, 'VAV Reheat', ht = 'NaturalGas', znht = 'NaturalGas', cl = 'Electricity', zones)
 
-    when 'VAV chiller with central air source heat pump reheat '
+    when 'VAV chiller with central air source heat pump reheat'
       standard.model_add_hvac_system(self, 'VAV Reheat', ht = 'AirSourceHeatPump', znht = 'AirSourceHeatPump', cl = 'Electricity', zones)
 
     when 'VAV chiller with district hot water reheat'
@@ -628,8 +631,8 @@ class OpenStudio::Model::Model
       standard.model_add_hvac_system(self, 'Window AC', ht = nil, znht = nil, cl = 'Electricity', cooled_zones)
 
     else
-      puts "HVAC system type '#{system_type}' not recognized"
-
+      return false
     end
+    return true
   end
 end

data/lib/measures/create_typical_doe_building_from_model/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008-2021, 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: