openstudio-model-articulation 0.3.1 → 0.6.0

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

@@ -12,59 +12,55 @@
 ## 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
 - [Measure Overview](#measure-overview)<br/>
 - [DOE Template and Building Type Mapping](#doe-template-and-building-type-mapping)<br/>
-- [Building Type Mix](#building-type-mix)<br/>
-- [Floor Area](#floor-area)<br/>
-- [Height, Stories, and Orientation](#height-stories-and-orientation)<br/>
-- [Building Shape](#building-shape)<br/>
-- [Window to Wall Ratio](#window-to-wall-ratio)<br/>
-- [Party Walls and Exposure of Top and Bottom Stories](#party-walls-and-exposure-of-top-and-bottom-stories)<br/>
-- [Calculation Methods and Articulation Logic](#calculation-methods-and-articulation-logic)<br/>
+- [Functionality and Input Overview](#functionality-and-input-overview)<br/>
+  - [Building Type Mix](#building-type-mix)<br/>
+  - [Floor Area](#floor-area)<br/>
+  - [Height, Stories, and Orientation](#height-stories-and-orientation)<br/>
+  - [Template](#template)<br/>
+  - [Building Shape](#building-shape)<br/>
+  - [Window to Wall Ratio](#window-to-wall-ratio)<br/>
+  - [Party Walls and Exposure of Top and Bottom Stories](#party-walls-and-exposure-of-top-and-bottom-stories)<br/>
+  - [Calculation Methods and Articulation Logic](#calculation-methods-and-articulation-logic)<br/>
 - [Development Comments](#development-comments)<br/>
 - [Automatically Generated Argument List](#arguments)<br/>
 
 ## Measure Overview
 
-The intent of this measure is to create basic geometry given a mix of building types and high level characteristics about the building envelope like the number of stories, aspect ratio, orientation etc. This will result in one or more rectangular building elements. The spaces will have stub space type assignments but will not have any internal loads or and the surfaces will not have constructions. The stub space type ratios are based on DOE prototype buildings, depending on the building type you select. The typical workflow is to run other measures after this measure that populate the stub space types and other model elements. This measure has 38 arguments and can look intimidating, but all of them have defaults, so it will run properly without you changing any arguments; however at a minimum you will typically want to at least choose the primary building type, building floor area, and number of stories above grade. Make use of additional arguments as you have a need to.
+The intent of this measure is to create basic geometry given a mix of building types and high level characteristics about the building envelope like the number of stories, aspect ratio, orientation etc. This will result in one or more rectangular building elements. The spaces will have stub space type assignments but will not have any internal loads or and the surfaces will not have constructions. The stub space type ratios are based on DOE prototype buildings, depending on the building type you select. The typical workflow is to run other measures after this measure that populate the stub space types and other model elements. This measure has more than 30 arguments and can look intimidating, but all of them have defaults, so it will run properly without you changing any arguments; however at a minimum you will typically want to at least choose the primary building type, building floor area, and number of stories above grade. Make use of additional arguments as you have a need to.
 
-This is generally meant to run on an empty model, but it does not activily delete any geometry or objects that may already be in the model.
+This is generally meant to run on an empty model, but it does not actively delete any geometry or objects that may already be in the model.
 
 ## 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)
+The Templates prefixed with "Comstock"" have been slightly modified over the template of the same name without the prefix to be more representation of general use inputs."
+
+#### Templates:
+<% arguments.each do |argument| %>
+<% if argument[:name] == 'template'%>
+<% argument[:choice_display_names].each do |choice|%>
+  - <%= choice %><br/>
+<% end %>
+<% end %>
+<% end %>
+
+#### Building Types::
+<% arguments.each do |argument| %>
+<% if argument[:name] == 'bldg_type_a'%>
+<% argument[:choice_display_names].each do |choice|%>
+- <%= choice %><br/>
+<% end %>
+<% end %>
+<% end %>
+
+[//]: # (argument values for template and bldg_type_a are dynamically generated from current version of the measure.)
 
 ## Functionality and Input Overview
 
@@ -76,7 +72,7 @@ Building Type A is an exception from the others in that it doesn't have an argum
 
 #### Floor Area
 
-The typical use case for this measure is to set the total building floor area using the `Total Building Floor Area` argument. With this approach you can maintain a set building floor area while changing the number of stories. An alternate workflow is to set a static footprint area. This alternate workflow is enabled by seeting a non-zero value for the `Single Floor Area` argument.
+The typical use case for this measure is to set the total building floor area using the `Total Building Floor Area` argument. With this approach you can maintain a set building floor area while changing the number of stories. An alternate workflow is to set a static footprint area. This alternate workflow is enabled by setting a non-zero value for the `Single Floor Area` argument.
 
 [//]: # (todo - add screenshot of same floor area on different num stories and shapes)
 
@@ -84,7 +80,7 @@ The typical use case for this measure is to set the total building floor area us
 
 The Floor to floor height for the building is controlled through the `Typical Floor to FLoor Height` argument. It is the first of a number of arguments where a value of 0 represents a **smart default**. If leave the default value of zero in place it will pick a building specific floor to floor height. For example 9' would be picked for a small hotel and 14' for a hospital.
 
-Some building types have space type specific definitions for height that can be enabled with the `Enable Custom Height Bar Application` argument. If I building doesn't have any custom heights defined the value of this argument will not matter. One example of where this argument would have an impact is for the gym and auditorum in the SecondarySchool which would have a height 26' instead of the default school height of 13'. This is accomplished by pulling space types with a custom height into a separate rectangular building that sits away from the main structure. If this argument is set to false then all of the space types will have the same height, which for the school would be the default of 13'
+Some building types have space type specific definitions for height that can be enabled with the `Enable Custom Height Bar Application` argument. If I building doesn't have any custom heights defined the value of this argument will not matter. One example of where this argument would have an impact is for the gym and auditorium in the SecondarySchool which would have a height 26' instead of the default school height of 13'. This is accomplished by pulling space types with a custom height into a separate rectangular building that sits away from the main structure. If this argument is set to false then all of the space types will have the same height, which for the school would be the default of 13'
 
 ![No Custom Height Space Types](./docs/custom_height_false.png?raw=true)
 *Secondary school without custom space type heights enabled*
@@ -97,11 +93,11 @@ There are two arguments that control the number of stories the building has. `Nu
 ![Baesment](./docs/basement.png?raw=true)
 *Secondary school with 1 below grade story*
 
-The `Building Rotation` argument will rotate the building after the geometry is created. So if you for example make a bar oriented east/west and then rotate it 80 degrees, the end result will be a bar just off of being north/south orientation. A positive value rotates clockwise. If you had a party wall assigned to the south facade, after the 80 degree rotation, those party walls would not be 10 degress south of due west.
+The `Building Rotation` argument will rotate the building after the geometry is created. So if you for example make a bar oriented east/west and then rotate it 80 degrees, the end result will be a bar just off of being north/south orientation. A positive value rotates clockwise. If you had a party wall assigned to the south facade, after the 80 degree rotation, those party walls would not be 10 degrees south of due west.
 
 #### Template
 
-The `Template` is uesed in OpenStudio measures and the OpenStudio standards gem to refer to a specific target building code standard or vintage. For exampe ASHRAE 90.1 2004 or the DOE Ref Pre-1980 vintage used for the DOE reference buildings. Template is used here along with the building types selected to define the list and ratios of space types in the model. While generally the space type ratio is the same across different templates there are exceptions to this such as the inclusion of data centers in newer LargeOffice buildings.
+The `Template` is used in OpenStudio measures and the OpenStudio standards gem to refer to a specific target building code standard or vintage. For example ASHRAE 90.1 2004 or the DOE Ref Pre-1980 vintage used for the DOE reference buildings. Template is used here along with the building types selected to define the list and ratios of space types in the model. While generally the space type ratio is the same across different templates there are exceptions to this such as the inclusion of data centers in newer LargeOffice buildings.
 
 #### Building Shape
 
@@ -111,12 +107,12 @@ While the floor area and number of stories arguments determine the size of the b
 *Aspect Ratio of 2.0*
 
 ![Aspect Ratio 1.0](./docs/ar_1.png?raw=true)
-*Aspect Ratio of 2.0*
+*Aspect Ratio of 1.0*
 
 ![Aspect Ratio 0.5](./docs/ar_05.png?raw=true)
 *Aspect Ratio of 0.5*
 
-The `Perimeter Multiplier` provides a mechanism to maintain your target footprint floor area and your target aspect ratio while increasing the total exterior perimeter exposure. The intent here is to support, in a simplified way, the impacts of non-rectangular buildings. This is accomplished by adding a second bar when necessary that is turned 90 degrees relative ot the primary bar but maintains the same width. These two building elements are separate from each other and from the custom height bar, if it exists. If you keep the default value of 0.0 the measure will lookup a value inferred from the prototype buidling. For most prototype buidling types this will result in a value of 1.0, because the buildings are rectangular, but for PrimarySchool, SecondarySchool, and Outpatient a value larger than 1.0 will be used. If you use or a smart default of 1.0 applied for this argument you get a single bar. As you increase the multiplier higher than 1.0 it will add a second bar to increase the building perimeter while maintaining both the floor area and the north south to east west aspect ratio. Below is an example of the calculation method. If you use a very small multiplier such as 1.05, a situation may exist that would have too small of a secondary bar to properly model. In this case the single bar will just be extended a bit to achive the target total perimeter, but will sacrifice meeting the requested north/south versus east/west aspect ratio. In some cases with when the multiplier is not high enough above 1 the ends of the secondary bar may be made adiabatic to achive target values.
+The `Perimeter Multiplier` provides a mechanism to maintain your target footprint floor area and your target aspect ratio while increasing the total exterior perimeter exposure. The intent here is to support, in a simplified way, the impacts of non-rectangular buildings. This is accomplished by adding a second bar when necessary that is turned 90 degrees relative ot the primary bar but maintains the same width. These two building elements are separate from each other and from the custom height bar, if it exists. If you keep the default value of 0.0 the measure will lookup a value inferred from the prototype building. For most prototype building types this will result in a value of 1.0, because the buildings are rectangular, but for PrimarySchool, SecondarySchool, and Outpatient a value larger than 1.0 will be used. If you use or a smart default of 1.0 applied for this argument you get a single bar. As you increase the multiplier higher than 1.0 it will add a second bar to increase the building perimeter while maintaining both the floor area and the north south to east west aspect ratio. Below is an example of the calculation method. If you use a very small multiplier such as 1.05, a situation may exist that would have too small of a secondary bar to properly model. In this case the single bar will just be extended a bit to achieve the target total perimeter, but will sacrifice meeting the requested north/south versus east/west aspect ratio. In some cases with when the multiplier is not high enough above 1 the ends of the secondary bar may be made adiabatic to achieve target values.
 
 ![Perim Mult b](./docs/perim_mult_2012.png?raw=true)
 *Aspect Ratio of 2.0 with a Perimeter Multiplier of 1.2. Able to add second bar but needs to have adiabatic ends. See earlier screenshot for Aspect Ratio of 2.0 with Perimeter Multiplier of 1.0*
@@ -131,9 +127,9 @@ The `Perimeter Multiplier` provides a mechanism to maintain your target footprin
 
  Representing for example a U shaped footprint (which might have a "Perimeter Multiplier" of 3 or higher) with a single bar would either under-estimate the perimeter if a reduced bounding box was fit around it to match the area, or over skew the orientation if a single long skinny bar was created with almost all of the exposure in only two opposing cardinal directions. A more common term that could have been used for an argument would have been a 1building perimeter to floor area ratio(P/A)`. That was considered but there could have been incompatible inputs passed in where the target P/A isn't possible for the given footprint area and aspect ratio. A 100' square has a P/A of 0.04 while a 1000' square has a ratio 0.004. In addition to changing with size it would also change with the shape of the rectangle. This measure in uses the multiplier to increase the perimeter of the foorprint(s) given a specified area and aspect ratio above the minim possible rectangular perimeter value. If you just want to make a single bar, you can leave the value at 1.0 and not worry about it. As a last note, if you also are using a custom height bar, that excluded from the calculation of the primary bar(s)
 
-`Bar Width` can be specified. If you know due to the layout of your building or other factors that you have a specific building width you would like to have you can enter that in the `Bar Width` argument. `Perimeter Multiplier` will be engored when a non-zero `Bar Width` is used. If you leave this argument value at the default value of 0 then it will not impact the model. A non-zero value here will also bypass the `Perimeter Multiplier` argument.
+`Bar Width` can be specified. If you know due to the layout of your building or other factors that you have a specific building width you would like to have you can enter that in the `Bar Width` argument. `Perimeter Multiplier` will be ignored when a non-zero `Bar Width` is used. If you leave this argument value at the default value of 0 then it will not impact the model. A non-zero value here will also bypass the `Perimeter Multiplier` argument.
 
-`Bar Separation Distance Multiplier` is used when there is more than one bar, to specify the distance between the bars as a multiple of the building height. The default value is 10 x the height of the building, but that can be customized here. Currently 0 is not a valid multiplier, since all the intersection, matching, and fenestration occur in the indivdual bar elements. When two bars are required to meet the `Perimeter Multiplier` target they are in configruation of an with the vertical leg to the right of the horizontal leg, like a backwards "L". If a custom heigth bar was use that will be positioned ot the left of the other bars.
+`Bar Separation Distance Multiplier` is used when there is more than one bar, to specify the distance between the bars as a multiple of the building height. The default value is 10 x the height of the building, but that can be customized here. Currently 0 is not a valid multiplier, since all the intersection, matching, and fenestration occur in the individual bar elements. When two bars are required to meet the `Perimeter Multiplier` target they are in configuration of an with the vertical leg to the right of the horizontal leg, like a backwards "L". If a custom height bar was used that will be positioned to the left of the other bars.
 
 ![Sept Dist 0.5](./docs/sep_05.png?raw=true)
 *Bar Separation Distance Multiplier of 0.5*
@@ -153,7 +149,7 @@ There is just a single `Window to Wall Ratio` argument for this measure. It has
 ![Custom WWR](./docs/wwr_custom.png?raw=true)
 *Example of space type specific WWR for warehouse model, shown with custom space type height enabled*
 
-Orientation specific characteristics and/or overhangs may be added to this in the future, but are currenty possible by adding existing measure to the workflow after this measure. Currently skylights are not directly supported either, but can be added outside of this measure.
+Orientation specific characteristics and/or overhangs may be added to this in the future, but are currently possible by adding existing measure to the workflow after this measure. Currently skylights are not directly supported either, but can be added outside of this measure.
 
 #### Party Walls and Exposure of Top and Bottom Stories
 
@@ -163,7 +159,7 @@ There are two approaches for the party walls. One approach is a single fraction
 
 The second approach is ideal when you know more about the conditions of a specific condition and allows you to enter an integer for reach cardinal direction with arguments named `Number of North facing stories with party wall` etc. You can for example have a 5 story building that has a 1 story building to the west, a 3 story building to the east, a 2 story building to the north, and exterior exposure to the south. If you are using this as part of a parametric study where number of stories is changeling and you want all of a specific facade to be adjacent to a building that is taller, You can enter an large value such as 99 for the value; the overly large value relative to number of stories in the building will not create any issues.
 
-The ability to model what is essence party floor/ceilings in your model are controlled through two bool arguments named `Is the Bottom Story Exposed to Ground` and `Is the Top Story an Exterior Roof`
+The ability to model what is in essence party floor/ceilings in your model are controlled through two bool arguments named `Is the Bottom Story Exposed to Ground` and `Is the Top Story an Exterior Roof`
 
 ![Party Wall](./docs/party.png?raw=true)
 *1 story Party wall on south, 2 story on east, story multipliers not enabled*
@@ -176,11 +172,11 @@ The ability to model what is essence party floor/ceilings in your model are cont
 
 #### Calculation Methods and Articulation Logic
 
-- `Calculation Method for Story Multiplier` is used to determine if zone multipliers should be used as story multipliers on taller buildings. This reduces the nubmer of zones and should speed up simulations, but may not be approriate in all cases. If you select a value of `None` then no (non 1) zone multipliers will be used and zones will be modeled for all building stories. The other choice currently available is `Basements Ground Mid Top` which for a building without party walls will never have more than 4 modeled stories regardless of the number of stories. The measure will evaluate uniqueness of stories taking into account party walls and may add additional stories to accommodate this. Note that while the size of space types on a story with a multiplier greater than 1 may appear smaller, they may be larger once the multiplier is applied.  More options may be added in the future, specifically vacations of something like `Basements Ground Midx5 Top` that for very tall buildings would and multiple mid-stories vs. a single mid-story.
+- `Calculation Method for Story Multiplier` is used to determine if zone multipliers should be used as story multipliers on taller buildings. This reduces the number of zones and should speed up simulations, but may not be appropriate in all cases. If you select a value of `None` then no (non 1) zone multipliers will be used and zones will be modeled for all building stories. The other choice currently available is `Basements Ground Mid Top` which for a building without party walls will never have more than 4 modeled stories regardless of the number of stories. The measure will evaluate uniqueness of stories taking into account party walls and may add additional stories to accommodate this. Note that while the size of space types on a story with a multiplier greater than 1 may appear smaller, they may be larger once the multiplier is applied.  More options may be added in the future, specifically vacations of something like `Basements Ground Midx5 Top` that for very tall buildings would and multiple mid-stories vs. a single mid-story.
 
 - `Make Mid Story Floor Surfaces Adiabatic` determines of surface intersection and surface matching should be applied between stories (when they are adjacent and capable of being matched e.g. story multiplier not used). Setting this to true can reduce the number of surfaces in the model
 
-- `Division Method for Bar Space Types` is used to determine how the internal zoning and space type division of the bar(s) is approached. The default vaue of `Multiple Space Types - Individual Stories Sliced` is the primary method that should be used. It creates what looks like a core and perimeter model, but slices it up by space type, with large space types moving towards the upper stories. There is some basic logic to minimize small slivers of a space type being createe that would create thermal zones with small volumes that may not simulate well. The two largest space types will be at the ends of the bars to minimize having excessive exterior exosure on a zone with a small floor area. `Multiple Space Types - Simple Sliced` is an earlier method that pre-dates the indivdual sliced stories. The logic is similar but it puts all space types on every building story and creates multiple stories with the exact same slicing logic. `Single Space Type - Core and Perimeter` is not sliced up by space type and isn't relevant for building types with multiple space types. If you do have a building type with only a single space type, like small or medium office, the multiple space type methods will still work. The single space type method will eventually be deprecated.
+- `Division Method for Bar Space Types` is used to determine how the internal zoning and space type division of the bar(s) is approached. The default value of `Multiple Space Types - Individual Stories Sliced` is the primary method that should be used. It creates what looks like a core and perimeter model, but slices it up by space type, with large space types moving towards the upper stories. There is some basic logic to minimize small slivers of a space type being created that would create thermal zones with small volumes that may not simulate well. The two largest space types will be at the ends of the bars to minimize having excessive exterior exposure on a zone with a small floor area. `Multiple Space Types - Simple Sliced` is an earlier method that pre-dates the individual sliced stories. The logic is similar but it puts all space types on every building story and creates multiple stories with the exact same slicing logic. `Single Space Type - Core and Perimeter` is not sliced up by space type and isn't relevant for building types with multiple space types. If you do have a building type with only a single space type, like small or medium office, the multiple space type methods will still work. The single space type method will eventually be deprecated.
 
 ![Individualy Sliced](./docs/bar_sliced_indiv.png?raw=true)
 *Multiple Space Types - Individual Stories Slice method that has been used through the examples above*
@@ -191,23 +187,21 @@ The ability to model what is essence party floor/ceilings in your model are cont
 ![Single Core Perimeter](./docs/bar_single_core_perim.png?raw=true)
 *Single Space Type - Core and Perimeter, should not be a reason to use this*
 
-- The `Double Loaded Corridor` arguemtn when enabled, take a circulation space type, when it exists, and pair it with the default space type, and will create a double loaded corridor for the space division and theral zoning, instead of the typical sliced core and perimeter zoning. This not only alters the geometry of the internal division, but creates a hybrid slice that instead of being a single space type, contains a circulation space type running down the center of the bar, surrounded by spaces of another space type. For an example, with a primary school the corridor will be paired with the classrooms. The width of the corridor is determined to achive the proper space type ratios of the two space types.
+- The `Double Loaded Corridor` argument when enabled, take a circulation space type, when it exists, and pair it with the default space type, and will create a double loaded corridor for the space division and thermal zoning, instead of the typical sliced core and perimeter zoning. This not only alters the geometry of the internal division, but creates a hybrid slice that instead of being a single space type, contains a circulation space type running down the center of the bar, surrounded by spaces of another space type. For an example, with a primary school the corridor will be paired with the classrooms. The width of the corridor is determined to achieve the proper space type ratios of the two space types.
 
 ![Double Loaded Corridor](./docs/bar_double_loaded.png?raw=true)
 *Double Loaded Corridor with classroom and corridor for secondary school.*
 
-- The `Choose Space Type Sorting Method` only comes into play when you are modeling a building with more than one building type. With `Size` selected the space types are organized by size, independent of the building type, with smaller space types on lower stories and larger space types on higher stories. `Building Type > Size` is a newer method that first sorts by buidling type, putting smaller building types on lower stories, and then within a buildng type will sort by size. An exmaple use case for this method is when modeling a 4 story building with 25% office and 75% large hotel. With the `Building Type > Size` value the first story will be entirly office, with the rest of the stories large hotel. If the `Size` value is selected, building types wll be mixed together.
+- The `Choose Space Type Sorting Method` only comes into play when you are modeling a building with more than one building type. With `Size` selected the space types are organized by size, independent of the building type, with smaller space types on lower stories and larger space types on higher stories. `Building Type > Size` is a newer method that first sorts by building type, putting smaller building types on lower stories, and then within a building type will sort by size. An example use case for this method is when modeling a 4 story building with 25% office and 75% large hotel. With the `Building Type > Size` value the first story will be entirely office, with the rest of the stories large hotel. If the `Size` value is selected, building types wll be mixed together.
 
 ![Sort Space Types by Building Types](./docs/story_sort.png?raw=true)
 *Building Type > Size used to sort by buiding types, and then by space types.*
 
-- `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 ase `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.
-
-- `Climate Zone` is not used at all by this measure but is necessary for an obscure reason
+- `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 a measures has unique argument names that don't exist in other measures, but some such ase `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 argument value for this measure.
 
 ## 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.
+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
@@ -227,6 +221,9 @@ ___
 **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_bar_from_doe_building_type_ratios/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,9 +41,9 @@ 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_geometry.rb'
-require 'openstudio/extension/core/os_lib_model_generation.rb'
-require 'openstudio/extension/core/os_lib_model_simplification.rb'
+require 'openstudio/extension/core/os_lib_geometry'
+require 'openstudio/extension/core/os_lib_model_generation'
+require 'openstudio/extension/core/os_lib_model_simplification'
 
 # start the measure
 class CreateBarFromDOEBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
@@ -68,6 +68,11 @@ class CreateBarFromDOEBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     return 'The building floor area can be described as a footprint size or as a total building area. The shape can be described by its aspect ratio or can be defined as a set width.'
   end
 
+  # used to populate taxonomy in readme.md
+  def taxonomy
+    return 'Envelope.Form'
+  end
+
   # define the arguments that the user will input
   def arguments(model)
     args = OpenStudio::Measure::OSArgumentVector.new
@@ -165,7 +170,7 @@ class CreateBarFromDOEBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     args << building_rotation
 
     # Make argument for template
-    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', get_doe_templates(true), true)
+    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', get_doe_templates(false), true)
     template.setDisplayName('Target Standard')
     template.setDefaultValue('90.1-2004')
     args << template

data/lib/measures/create_bar_from_doe_building_type_ratios/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>create_bar_from_doe_building_type_ratios</name>
   <uid>0de3cff9-c805-42c4-964e-18cb43a22c63</uid>
-  <version_id>1e92f356-df92-40c7-838e-30843c91521c</version_id>
-  <version_modified>20200509T155941Z</version_modified>
+  <version_id>f5f51bc7-16a3-4829-82fb-3bcbb773a33a</version_id>
+  <version_modified>20220505T182934Z</version_modified>
   <xml_checksum>5F523097</xml_checksum>
   <class_name>CreateBarFromDOEBuildingTypeRatios</class_name>
   <display_name>Create Bar From DOE Building Type Ratios</display_name>
@@ -87,6 +87,26 @@
           <value>SuperMarket</value>
           <display_name>SuperMarket</display_name>
         </choice>
+        <choice>
+          <value>Laboratory</value>
+          <display_name>Laboratory</display_name>
+        </choice>
+        <choice>
+          <value>LargeDataCenterLowITE</value>
+          <display_name>LargeDataCenterLowITE</display_name>
+        </choice>
+        <choice>
+          <value>LargeDataCenterHighITE</value>
+          <display_name>LargeDataCenterHighITE</display_name>
+        </choice>
+        <choice>
+          <value>SmallDataCenterLowITE</value>
+          <display_name>SmallDataCenterLowITE</display_name>
+        </choice>
+        <choice>
+          <value>SmallDataCenterHighITE</value>
+          <display_name>SmallDataCenterHighITE</display_name>
+        </choice>
       </choices>
     </argument>
     <argument>
@@ -165,6 +185,26 @@
           <value>SuperMarket</value>
           <display_name>SuperMarket</display_name>
         </choice>
+        <choice>
+          <value>Laboratory</value>
+          <display_name>Laboratory</display_name>
+        </choice>
+        <choice>
+          <value>LargeDataCenterLowITE</value>
+          <display_name>LargeDataCenterLowITE</display_name>
+        </choice>
+        <choice>
+          <value>LargeDataCenterHighITE</value>
+          <display_name>LargeDataCenterHighITE</display_name>
+        </choice>
+        <choice>
+          <value>SmallDataCenterLowITE</value>
+          <display_name>SmallDataCenterLowITE</display_name>
+        </choice>
+        <choice>
+          <value>SmallDataCenterHighITE</value>
+          <display_name>SmallDataCenterHighITE</display_name>
+        </choice>
       </choices>
     </argument>
     <argument>
@@ -251,6 +291,26 @@
           <value>SuperMarket</value>
           <display_name>SuperMarket</display_name>
         </choice>
+        <choice>
+          <value>Laboratory</value>
+          <display_name>Laboratory</display_name>
+        </choice>
+        <choice>
+          <value>LargeDataCenterLowITE</value>
+          <display_name>LargeDataCenterLowITE</display_name>
+        </choice>
+        <choice>
+          <value>LargeDataCenterHighITE</value>
+          <display_name>LargeDataCenterHighITE</display_name>
+        </choice>
+        <choice>
+          <value>SmallDataCenterLowITE</value>
+          <display_name>SmallDataCenterLowITE</display_name>
+        </choice>
+        <choice>
+          <value>SmallDataCenterHighITE</value>
+          <display_name>SmallDataCenterHighITE</display_name>
+        </choice>
       </choices>
     </argument>
     <argument>
@@ -337,6 +397,26 @@
           <value>SuperMarket</value>
           <display_name>SuperMarket</display_name>
         </choice>
+        <choice>
+          <value>Laboratory</value>
+          <display_name>Laboratory</display_name>
+        </choice>
+        <choice>
+          <value>LargeDataCenterLowITE</value>
+          <display_name>LargeDataCenterLowITE</display_name>
+        </choice>
+        <choice>
+          <value>LargeDataCenterHighITE</value>
+          <display_name>LargeDataCenterHighITE</display_name>
+        </choice>
+        <choice>
+          <value>SmallDataCenterLowITE</value>
+          <display_name>SmallDataCenterLowITE</display_name>
+        </choice>
+        <choice>
+          <value>SmallDataCenterHighITE</value>
+          <display_name>SmallDataCenterHighITE</display_name>
+        </choice>
       </choices>
     </argument>
     <argument>
@@ -454,8 +534,36 @@
           <display_name>90.1-2013</display_name>
         </choice>
         <choice>
-          <value>NREL ZNE Ready 2017</value>
-          <display_name>NREL ZNE Ready 2017</display_name>
+          <value>90.1-2016</value>
+          <display_name>90.1-2016</display_name>
+        </choice>
+        <choice>
+          <value>90.1-2019</value>
+          <display_name>90.1-2019</display_name>
+        </choice>
+        <choice>
+          <value>ComStock DOE Ref Pre-1980</value>
+          <display_name>ComStock DOE Ref Pre-1980</display_name>
+        </choice>
+        <choice>
+          <value>ComStock DOE Ref 1980-2004</value>
+          <display_name>ComStock DOE Ref 1980-2004</display_name>
+        </choice>
+        <choice>
+          <value>ComStock 90.1-2004</value>
+          <display_name>ComStock 90.1-2004</display_name>
+        </choice>
+        <choice>
+          <value>ComStock 90.1-2007</value>
+          <display_name>ComStock 90.1-2007</display_name>
+        </choice>
+        <choice>
+          <value>ComStock 90.1-2010</value>
+          <display_name>ComStock 90.1-2010</display_name>
+        </choice>
+        <choice>
+          <value>ComStock 90.1-2013</value>
+          <display_name>ComStock 90.1-2013</display_name>
         </choice>
       </choices>
     </argument>
@@ -880,23 +988,23 @@
       <usage_type>doc</usage_type>
       <checksum>D1E7B644</checksum>
     </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>A21A3ED2</checksum>
+    </file>
     <file>
       <filename>README.md.erb</filename>
       <filetype>erb</filetype>
       <usage_type>readmeerb</usage_type>
-      <checksum>87CB14B2</checksum>
+      <checksum>764EC4D9</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>8A37AD01</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>7D3973D6</checksum>
     </file>
     <file>
       <version>
@@ -907,13 +1015,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>6B0D2DD7</checksum>
+      <checksum>415570D1</checksum>
     </file>
     <file>
       <filename>create_bar_from_doe_building_type_ratios_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>1C04409F</checksum>
+      <checksum>0CABBDFA</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/create_bar_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:

data/lib/measures/create_bar_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:
@@ -39,9 +39,9 @@
 # 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_geometry.rb'
-require 'openstudio/extension/core/os_lib_model_generation.rb'
-require 'openstudio/extension/core/os_lib_model_simplification.rb'
+require 'openstudio/extension/core/os_lib_geometry'
+require 'openstudio/extension/core/os_lib_model_generation'
+require 'openstudio/extension/core/os_lib_model_simplification'
 
 # start the measure
 class CreateBarFromModel < OpenStudio::Measure::ModelMeasure
@@ -302,11 +302,12 @@ class CreateBarFromModel < OpenStudio::Measure::ModelMeasure
     #  end
 
     # define length and with of bar
-    if bar_calc_method == 'Bar - Reduced Bounding Box'
+    case bar_calc_method
+    when 'Bar - Reduced Bounding Box'
       bar_calc = calc_bar_reduced_bounding_box(envelope_data_hash)
-    elsif bar_calc_method == 'Bar - Reduced Width'
+    when 'Bar - Reduced Width'
       bar_calc = calc_bar_reduced_width(envelope_data_hash)
-    elsif bar_calc_method == 'Bar - Stretched'
+    when 'Bar - Stretched'
       bar_calc = calc_bar_stretched(envelope_data_hash)
     end
 
@@ -345,6 +346,7 @@ class CreateBarFromModel < OpenStudio::Measure::ModelMeasure
     zone_hash = {} # key is zone value is floor area. It excludes zones with non 1 multiplier
     model.getThermalZones.each do |thermal_zone|
       next if thermal_zone.multiplier > 1
+
       zone_hash[thermal_zone] = thermal_zone.floorArea
     end
     target_zone = zone_hash.key(zone_hash.values.max)
@@ -372,6 +374,7 @@ class CreateBarFromModel < OpenStudio::Measure::ModelMeasure
         # restore thermostats for space type saved from old geometry
         model.getThermalZones.each do |thermal_zone|
           next if !thermal_zone.spaces.first.spaceType.is_initialized
+
           space_type = thermal_zone.spaces.first.spaceType.get
           new_thermostat = OpenStudio::Model::ThermostatSetpointDualSetpoint.new(model)
           new_thermostat.setHeatingSetpointTemperatureSchedule(htg_setpoints[space_type])
@@ -388,6 +391,7 @@ class CreateBarFromModel < OpenStudio::Measure::ModelMeasure
     final_ratios = {}
     model.getSpaceTypes.each do |space_type|
       next if space_type.floorArea == 0.0
+
       final_ratios[space_type] = space_type.floorArea / final_floor_area
     end
     Hash[final_ratios.sort_by { |k, v| v }.reverse].each do |k, v|

data/lib/measures/create_bar_from_model/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>create_bar_from_model</name>
   <uid>87fb0783-7a38-4900-8969-40e744c67814</uid>
-  <version_id>5eff35df-f390-4ac9-8bd6-683400df6e2a</version_id>
-  <version_modified>20200509T155940Z</version_modified>
+  <version_id>c5c23516-2e33-4fe3-8c26-bfedc90f3584</version_id>
+  <version_modified>20220505T182934Z</version_modified>
   <xml_checksum>2AF3A68E</xml_checksum>
   <class_name>CreateBarFromModel</class_name>
   <display_name>Create Bar From Model</display_name>
@@ -142,7 +142,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>A21A3ED2</checksum>
     </file>
     <file>
       <version>
@@ -153,13 +153,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>B7B7B95D</checksum>
+      <checksum>364B6970</checksum>
     </file>
     <file>
       <filename>create_bar_from_model_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>AE3DA592</checksum>
+      <checksum>B77C7D72</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/create_bar_from_space_type_ratios/LICENSE.md

@@ -0,0 +1,27 @@
+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:
+
+(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.