openstudio-model-articulation 0.4.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +3 -1
  3. data/CHANGELOG.md +13 -0
  4. data/Gemfile +2 -2
  5. data/README.md +14 -0
  6. data/lib/measures/SetWindowToWallRatioByFacade/measure.rb +10 -3
  7. data/lib/measures/SetWindowToWallRatioByFacade/measure.xml +10 -4
  8. data/lib/measures/add_empd_material_properties/LICENSE.md +27 -0
  9. data/lib/measures/add_empd_material_properties/README.md +116 -0
  10. data/lib/measures/add_empd_material_properties/README.md.erb +42 -0
  11. data/lib/measures/add_empd_material_properties/docs/.gitkeep +0 -0
  12. data/lib/measures/add_empd_material_properties/measure.rb +247 -0
  13. data/lib/measures/add_empd_material_properties/measure.xml +201 -0
  14. data/lib/measures/create_DOE_prototype_building/measure.xml +2 -2
  15. data/lib/measures/create_bar_from_building_type_ratios/README.md +109 -35
  16. data/lib/measures/create_bar_from_building_type_ratios/README.md.erb +54 -35
  17. data/lib/measures/create_bar_from_building_type_ratios/measure.rb +5 -0
  18. data/lib/measures/create_bar_from_building_type_ratios/measure.xml +16 -16
  19. data/lib/measures/create_bar_from_deer_building_type_ratios/README.md +301 -79
  20. data/lib/measures/create_bar_from_deer_building_type_ratios/README.md.erb +62 -79
  21. data/lib/measures/create_bar_from_deer_building_type_ratios/measure.rb +6 -1
  22. data/lib/measures/create_bar_from_deer_building_type_ratios/measure.xml +19 -63
  23. data/lib/measures/create_bar_from_doe_building_type_ratios/README.md +298 -57
  24. data/lib/measures/create_bar_from_doe_building_type_ratios/README.md.erb +54 -57
  25. data/lib/measures/create_bar_from_doe_building_type_ratios/measure.rb +6 -1
  26. data/lib/measures/create_bar_from_doe_building_type_ratios/measure.xml +16 -20
  27. data/lib/measures/create_bar_from_space_type_ratios/README.md +94 -42
  28. data/lib/measures/create_bar_from_space_type_ratios/README.md.erb +60 -42
  29. data/lib/measures/create_bar_from_space_type_ratios/measure.rb +5 -0
  30. data/lib/measures/create_bar_from_space_type_ratios/measure.xml +19 -19
  31. data/lib/measures/create_baseline_building/measure.xml +2 -2
  32. data/lib/measures/create_deer_prototype_building/measure.xml +2 -2
  33. data/lib/measures/create_typical_building_from_model/README.md +81 -16
  34. data/lib/measures/create_typical_building_from_model/README.md.erb +36 -16
  35. data/lib/measures/create_typical_building_from_model/measure.rb +5 -0
  36. data/lib/measures/create_typical_building_from_model/measure.xml +19 -19
  37. data/lib/measures/create_typical_deer_building_from_model/README.md +173 -53
  38. data/lib/measures/create_typical_deer_building_from_model/README.md.erb +57 -53
  39. data/lib/measures/create_typical_deer_building_from_model/measure.rb +6 -1
  40. data/lib/measures/create_typical_deer_building_from_model/measure.xml +25 -25
  41. data/lib/measures/create_typical_doe_building_from_model/README.md +182 -44
  42. data/lib/measures/create_typical_doe_building_from_model/README.md.erb +58 -44
  43. data/lib/measures/create_typical_doe_building_from_model/measure.rb +6 -1
  44. data/lib/measures/create_typical_doe_building_from_model/measure.xml +25 -25
  45. data/lib/measures/radiant_slab_with_doas/measure.rb +5 -1
  46. data/lib/measures/radiant_slab_with_doas/measure.xml +9 -9
  47. data/lib/openstudio/model_articulation/version.rb +1 -1
  48. data/openstudio-model-articulation.gemspec +2 -2
  49. metadata +13 -7
@@ -13,9 +13,9 @@ It is important that the template argument chosen for this measure is in line wi
13
13
  ## Measure Type
14
14
  ModelMeasure
15
15
 
16
- [//]: # (Commenting out until it works in SDK)
17
- [//]: # (## Taxonomy)
18
- [//]: # ()
16
+ [//]: # (Only finds value if taxonomy method is added to measure.rb, won't read out of measure.xml)
17
+ ## Taxonomy
18
+ Whole Building.Space Types
19
19
 
20
20
  ___
21
21
  ## Table of Contents
@@ -36,48 +36,120 @@ While this measure has many arguments, they all have default values so you can s
36
36
 
37
37
  ## DEER Template and Building Type Mapping
38
38
 
39
- - Templates:
40
- - DEER Pre-1975
41
- - DEER 1985
42
- - DEER 1996
43
- - DEER 2003
44
- - DEER 2007
45
- - DEER 2011
46
- - DEER 2014
47
- - DEER 2015
48
- - DEER 2017
49
- - DEER 2020
50
- - Building Types:
51
- - Asm
52
- - DMo
53
- - ECC
54
- - EPr
55
- - ERC
56
- - ESe
57
- - EUn
58
- - GHs
59
- - Gro
60
- - Hsp
61
- - Htl
62
- - MBT
63
- - MFm
64
- - MLI
65
- - Mtl
66
- - Nrs
67
- - OfL
68
- - OfS
69
- - RFF
70
- - RSD
71
- - Rt3
72
- - RtL
73
- - RtS
74
- - SCn
75
- - SFm
76
- - SUn
77
- - WRf
39
+ #### Templates:
40
+
41
+
42
+
43
+ - DEER Pre-1975<br/>
44
+
45
+ - DEER 1985<br/>
46
+
47
+ - DEER 1996<br/>
48
+
49
+ - DEER 2003<br/>
50
+
51
+ - DEER 2007<br/>
52
+
53
+ - DEER 2011<br/>
54
+
55
+ - DEER 2014<br/>
56
+
57
+ - DEER 2015<br/>
58
+
59
+ - DEER 2017<br/>
60
+
61
+ - DEER 2020<br/>
62
+
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+ #### Building Types:
123
+ - Asm
124
+ - DMo
125
+ - ECC
126
+ - EPr
127
+ - ERC
128
+ - ESe
129
+ - EUn
130
+ - GHs
131
+ - Gro
132
+ - Hsp
133
+ - Htl
134
+ - MBT
135
+ - MFm
136
+ - MLI
137
+ - Mtl
138
+ - Nrs
139
+ - OfL
140
+ - OfS
141
+ - RFF
142
+ - RSD
143
+ - Rt3
144
+ - RtL
145
+ - RtS
146
+ - SCn
147
+ - SFm
148
+ - SUn
149
+ - WRf
78
150
 
79
151
  [//]: # (Provide link to map DEER abbreviation to full building type name)
80
- [//]: # (Would be nice to make these lists dynamic from the measure to they don't become outdated)
152
+ [//]: # (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.)
81
153
 
82
154
  ## HVAC Configuration Arguments
83
155
 
@@ -101,16 +173,16 @@ While this measure has many arguments, they all have default values so you can s
101
173
 
102
174
  ## Bool Arguments to Enable/Disable Elements of This Measure
103
175
 
104
- The following is a list of aruments for elements of the model that can be enabled or disabled for the measure.
176
+ The following is a list of arguments for elements of the model that can be enabled or disabled for the measure.
105
177
  - `Add Constructions to Model`
106
178
  - `Add Space Type Loads to Model`
107
- - `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.
179
+ - `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.
108
180
  - `Add Internal Mass to Model`
109
181
  - `Add Exterior Lights to Model`
110
182
  - `Add Exhaust Fans to Model`
111
183
  - `Add Service Water Heating to Model`
112
184
  - `Add Thermostats`
113
- - `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.
185
+ - `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.
114
186
  - `Add Refrigeration to Model`
115
187
 
116
188
  ## Hours of Operation Arguments
@@ -124,19 +196,22 @@ There are three arguments each for weekday and weekend behavior. In each case th
124
196
 
125
197
  ## Other Arguments
126
198
 
127
- - `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.
199
+ - `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.
128
200
  - `Unmet Hours Tolerance` is used to change the tolerance used in EnergyPlus for unmet heating and cooling hours.
129
- - `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.
201
+ - `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.
130
202
  - `Enable Daylight Savings` will change daylighting saving to true when enabled.
131
203
 
132
204
  ## Development Comments
133
205
 
134
- 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.
135
- - os_lib_model_generation.rb
136
- - os_lib_helper_methods.rb
137
- - os_lib_helper_methods.rb
206
+ 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.
207
+ - os_lib_model_generation.rb
208
+ - os_lib_model_simplification.rb
209
+ - os_lib_geometry.rb
210
+ - os_lib_helper_methods.rb
211
+
212
+ *(Automatically generated argument information follows)*
138
213
 
139
- *(Automatically generated argument information follows)*## Arguments
214
+ ## Arguments
140
215
 
141
216
 
142
217
  ### Target Standard
@@ -147,6 +222,9 @@ This measure relies on the openstudio-standards gem which is included in the Ope
147
222
  **Required:** true,
148
223
  **Model Dependent:** false
149
224
 
225
+ **Choice Display Names** ["DEER Pre-1975", "DEER 1985", "DEER 1996", "DEER 2003", "DEER 2007", "DEER 2011", "DEER 2014", "DEER 2015", "DEER 2017", "DEER 2020"]
226
+
227
+
150
228
  ### HVAC System Type
151
229
 
152
230
  **Name:** system_type,
@@ -155,6 +233,9 @@ This measure relies on the openstudio-standards gem which is included in the Ope
155
233
  **Required:** true,
156
234
  **Model Dependent:** false
157
235
 
236
+ **Choice Display Names** ["Inferred", "Ideal Air Loads", "Baseboard electric", "Baseboard gas boiler", "Baseboard central air source heat pump", "Baseboard district hot water", "Direct evap coolers with baseboard electric", "Direct evap coolers with baseboard gas boiler", "Direct evap coolers with baseboard central air source heat pump", "Direct evap coolers with baseboard district hot water", "Direct evap coolers with forced air furnace", "Direct evap coolers with gas unit heaters", "Direct evap coolers with no heat", "DOAS with fan coil chiller with boiler", "DOAS with fan coil chiller with central air source heat pump", "DOAS with fan coil chiller with district hot water", "DOAS with fan coil chiller with baseboard electric", "DOAS with fan coil chiller with gas unit heaters", "DOAS with fan coil chiller with no heat", "DOAS with fan coil air-cooled chiller with boiler", "DOAS with fan coil air-cooled chiller with central air source heat pump", "DOAS with fan coil air-cooled chiller with district hot water", "DOAS with fan coil air-cooled chiller with baseboard electric", "DOAS with fan coil air-cooled chiller with gas unit heaters", "DOAS with fan coil air-cooled chiller with no heat", "DOAS with fan coil district chilled water with boiler", "DOAS with fan coil district chilled water with central air source heat pump", "DOAS with fan coil district chilled water with district hot water", "DOAS with fan coil district chilled water with baseboard electric", "DOAS with fan coil district chilled water with gas unit heaters", "DOAS with fan coil district chilled water with no heat", "DOAS with VRF", "DOAS with water source heat pumps fluid cooler with boiler", "DOAS with water source heat pumps cooling tower with boiler", "DOAS with water source heat pumps with ground source heat pump", "DOAS with water source heat pumps district chilled water with district hot water", "Fan coil chiller with boiler", "Fan coil chiller with central air source heat pump", "Fan coil chiller with district hot water", "Fan coil chiller with baseboard electric", "Fan coil chiller with gas unit heaters", "Fan coil chiller with no heat", "Fan coil air-cooled chiller with boiler", "Fan coil air-cooled chiller with central air source heat pump", "Fan coil air-cooled chiller with district hot water", "Fan coil air-cooled chiller with baseboard electric", "Fan coil air-cooled chiller with gas unit heaters", "Fan coil air-cooled chiller with no heat", "Fan coil district chilled water with boiler", "Fan coil district chilled water with central air source heat pump", "Fan coil district chilled water with district hot water", "Fan coil district chilled water with baseboard electric", "Fan coil district chilled water with gas unit heaters", "Fan coil district chilled water with no heat", "Forced air furnace", "Gas unit heaters", "PTAC with baseboard electric", "PTAC with baseboard gas boiler", "PTAC with baseboard district hot water", "PTAC with gas unit heaters", "PTAC with electric coil", "PTAC with gas coil", "PTAC with gas boiler", "PTAC with central air source heat pump", "PTAC with district hot water", "PTAC with no heat", "PTHP", "PSZ-AC with baseboard electric", "PSZ-AC with baseboard gas boiler", "PSZ-AC with baseboard district hot water", "PSZ-AC with gas unit heaters", "PSZ-AC with electric coil", "PSZ-AC with gas coil", "PSZ-AC with gas boiler", "PSZ-AC with central air source heat pump", "PSZ-AC with district hot water", "PSZ-AC with no heat", "PSZ-AC district chilled water with baseboard electric", "PSZ-AC district chilled water with baseboard gas boiler", "PSZ-AC district chilled water with baseboard district hot water", "PSZ-AC district chilled water with gas unit heaters", "PSZ-AC district chilled water with electric coil", "PSZ-AC district chilled water with gas coil", "PSZ-AC district chilled water with gas boiler", "PSZ-AC district chilled water with central air source heat pump", "PSZ-AC district chilled water with district hot water", "PSZ-AC district chilled water with no heat", "PSZ-HP", "PVAV with gas boiler reheat", "PVAV with central air source heat pump reheat", "PVAV with district hot water reheat", "PVAV with PFP boxes", "PVAV with gas heat with electric reheat", "Residential AC with baseboard electric", "Residential AC with baseboard gas boiler", "Residential AC with baseboard central air source heat pump", "Residential AC with baseboard district hot water", "Residential AC with residential forced air furnace", "Residential AC with no heat", "Residential heat pump", "Residential heat pump with no cooling", "Residential forced air furnace", "VAV chiller with gas boiler reheat", "VAV chiller with central air source heat pump reheat", "VAV chiller with district hot water reheat", "VAV chiller with PFP boxes", "VAV chiller with gas coil reheat", "VAV chiller with no reheat with baseboard electric", "VAV chiller with no reheat with gas unit heaters", "VAV chiller with no reheat with zone heat pump", "VAV air-cooled chiller with gas boiler reheat", "VAV air-cooled chiller with central air source heat pump reheat", "VAV air-cooled chiller with district hot water reheat", "VAV air-cooled chiller with PFP boxes", "VAV air-cooled chiller with gas coil reheat", "VAV air-cooled chiller with no reheat with baseboard electric", "VAV air-cooled chiller with no reheat with gas unit heaters", "VAV air-cooled chiller with no reheat with zone heat pump", "VAV district chilled water with gas boiler reheat", "VAV district chilled water with central air source heat pump reheat", "VAV district chilled water with district hot water reheat", "VAV district chilled water with PFP boxes", "VAV district chilled water with gas coil reheat", "VAV district chilled water with no reheat with baseboard electric", "VAV district chilled water with no reheat with gas unit heaters", "VAV district chilled water with no reheat with zone heat pump", "VRF", "Water source heat pumps fluid cooler with boiler", "Water source heat pumps cooling tower with boiler", "Water source heat pumps with ground source heat pump", "Water source heat pumps district chilled water with district hot water", "Window AC with baseboard electric", "Window AC with baseboard gas boiler", "Window AC with baseboard central air source heat pump", "Window AC with baseboard district hot water", "Window AC with forced air furnace", "Window AC with unit heaters", "Window AC with no heat"]
237
+
238
+
158
239
  ### HVAC System Delivery Type
159
240
  How the HVAC system delivers heating or cooling to the zone.
160
241
  **Name:** hvac_delivery_type,
@@ -163,6 +244,9 @@ How the HVAC system delivers heating or cooling to the zone.
163
244
  **Required:** true,
164
245
  **Model Dependent:** false
165
246
 
247
+ **Choice Display Names** ["Forced Air", "Hydronic"]
248
+
249
+
166
250
  ### HVAC Heating Source
167
251
  The primary source of heating used by HVAC systems in the model.
168
252
  **Name:** htg_src,
@@ -171,6 +255,9 @@ The primary source of heating used by HVAC systems in the model.
171
255
  **Required:** true,
172
256
  **Model Dependent:** false
173
257
 
258
+ **Choice Display Names** ["Electricity", "NaturalGas", "DistrictHeating", "DistrictAmbient"]
259
+
260
+
174
261
  ### HVAC Cooling Source
175
262
  The primary source of cooling used by HVAC systems in the model.
176
263
  **Name:** clg_src,
@@ -179,6 +266,9 @@ The primary source of cooling used by HVAC systems in the model.
179
266
  **Required:** true,
180
267
  **Model Dependent:** false
181
268
 
269
+ **Choice Display Names** ["Electricity", "DistrictCooling", "DistrictAmbient"]
270
+
271
+
182
272
  ### Service Water Heating Source
183
273
  The primary source of heating used by SWH systems in the model.
184
274
  **Name:** swh_src,
@@ -187,6 +277,9 @@ The primary source of heating used by SWH systems in the model.
187
277
  **Required:** true,
188
278
  **Model Dependent:** false
189
279
 
280
+ **Choice Display Names** ["Inferred", "NaturalGas", "Electricity", "HeatPump"]
281
+
282
+
190
283
  ### Kitchen Exhaust MakeUp Air Calculation Method
191
284
  Determine logic to identify dining or cafe zones to provide makeup air to kitchen exhaust.
192
285
  **Name:** kitchen_makeup,
@@ -195,6 +288,9 @@ Determine logic to identify dining or cafe zones to provide makeup air to kitche
195
288
  **Required:** true,
196
289
  **Model Dependent:** false
197
290
 
291
+ **Choice Display Names** ["None", "Largest Zone", "Adjacent"]
292
+
293
+
198
294
  ### Exterior Lighting Zone
199
295
  Identify the Exterior Lighting Zone for the Building Site.
200
296
  **Name:** exterior_lighting_zone,
@@ -203,6 +299,9 @@ Identify the Exterior Lighting Zone for the Building Site.
203
299
  **Required:** true,
204
300
  **Model Dependent:** false
205
301
 
302
+ **Choice Display Names** ["0 - Undeveloped Areas Parks", "1 - Developed Areas Parks", "2 - Neighborhood", "3 - All Other Areas", "4 - High Activity"]
303
+
304
+
206
305
  ### Add Constructions to Model
207
306
  Construction Set will be applied to entire building
208
307
  **Name:** add_constructions,
@@ -211,6 +310,7 @@ Construction Set will be applied to entire building
211
310
  **Required:** true,
212
311
  **Model Dependent:** false
213
312
 
313
+
214
314
  ### Add Space Type Loads to Model
215
315
  Populate existing space types in model with internal loads.
216
316
  **Name:** add_space_type_loads,
@@ -219,6 +319,7 @@ Populate existing space types in model with internal loads.
219
319
  **Required:** true,
220
320
  **Model Dependent:** false
221
321
 
322
+
222
323
  ### Add Elevators to Model
223
324
  Elevators will be add directly to space in model vs. being applied to a space type.
224
325
  **Name:** add_elevators,
@@ -227,6 +328,7 @@ Elevators will be add directly to space in model vs. being applied to a space ty
227
328
  **Required:** true,
228
329
  **Model Dependent:** false
229
330
 
331
+
230
332
  ### Add Internal Mass to Model
231
333
  Adds internal mass to each space.
232
334
  **Name:** add_internal_mass,
@@ -235,6 +337,7 @@ Adds internal mass to each space.
235
337
  **Required:** true,
236
338
  **Model Dependent:** false
237
339
 
340
+
238
341
  ### Add Exterior Lights to Model
239
342
  Multiple exterior lights objects will be added for different classes of lighting such as parking and facade.
240
343
  **Name:** add_exterior_lights,
@@ -243,6 +346,7 @@ Multiple exterior lights objects will be added for different classes of lighting
243
346
  **Required:** true,
244
347
  **Model Dependent:** false
245
348
 
349
+
246
350
  ### Onsite Parking Fraction
247
351
  If set to 0 no exterior lighting for parking will be added
248
352
  **Name:** onsite_parking_fraction,
@@ -251,6 +355,7 @@ If set to 0 no exterior lighting for parking will be added
251
355
  **Required:** true,
252
356
  **Model Dependent:** false
253
357
 
358
+
254
359
  ### Add Exhaust Fans to Model
255
360
  Depending upon building type exhaust fans can be in kitchens, restrooms or other space types
256
361
  **Name:** add_exhaust,
@@ -259,6 +364,7 @@ Depending upon building type exhaust fans can be in kitchens, restrooms or other
259
364
  **Required:** true,
260
365
  **Model Dependent:** false
261
366
 
367
+
262
368
  ### Add Service Water Heating to Model
263
369
  This will add both the supply and demand side of service water heating.
264
370
  **Name:** add_swh,
@@ -267,6 +373,7 @@ This will add both the supply and demand side of service water heating.
267
373
  **Required:** true,
268
374
  **Model Dependent:** false
269
375
 
376
+
270
377
  ### Add Thermostats
271
378
  Add Thermostat to model based on Space Type Standards information of spaces assigned to thermal zones.
272
379
  **Name:** add_thermostat,
@@ -275,6 +382,7 @@ Add Thermostat to model based on Space Type Standards information of spaces assi
275
382
  **Required:** true,
276
383
  **Model Dependent:** false
277
384
 
385
+
278
386
  ### Add HVAC System to Model
279
387
  Add HVAC System to the model
280
388
  **Name:** add_hvac,
@@ -283,6 +391,7 @@ Add HVAC System to the model
283
391
  **Required:** true,
284
392
  **Model Dependent:** false
285
393
 
394
+
286
395
  ### Add Refrigeration to Model
287
396
  Add refrigeration cases and walkins model
288
397
  **Name:** add_refrigeration,
@@ -291,6 +400,7 @@ Add refrigeration cases and walkins model
291
400
  **Required:** true,
292
401
  **Model Dependent:** false
293
402
 
403
+
294
404
  ### Modify weekday hours of operation
295
405
  Modify the weekday hours of operation in the model.
296
406
  **Name:** modify_wkdy_op_hrs,
@@ -299,6 +409,7 @@ Modify the weekday hours of operation in the model.
299
409
  **Required:** true,
300
410
  **Model Dependent:** false
301
411
 
412
+
302
413
  ### Weekday Operating Hours Start Time
303
414
  Enter 24 hour values with fractional values converted to minutes. e.g. 17.25 = 5:15pm. Only used if Modify weekday hours of operation is true.
304
415
  **Name:** wkdy_op_hrs_start_time,
@@ -307,6 +418,7 @@ Enter 24 hour values with fractional values converted to minutes. e.g. 17.25 = 5
307
418
  **Required:** true,
308
419
  **Model Dependent:** false
309
420
 
421
+
310
422
  ### Weekday Operating Hours Duration
311
423
  Length of weekday operating hours. Enter 24 hour values with fractional values converted to minutes. e.g. 17.25 = 5:15pm. Only used if Modify weekday hours of operation is true.
312
424
  **Name:** wkdy_op_hrs_duration,
@@ -315,6 +427,7 @@ Length of weekday operating hours. Enter 24 hour values with fractional values c
315
427
  **Required:** true,
316
428
  **Model Dependent:** false
317
429
 
430
+
318
431
  ### Modify weekend hours of operation
319
432
  Modify the weekend hours of operation in the model.
320
433
  **Name:** modify_wknd_op_hrs,
@@ -323,6 +436,7 @@ Modify the weekend hours of operation in the model.
323
436
  **Required:** true,
324
437
  **Model Dependent:** false
325
438
 
439
+
326
440
  ### Weekend Operating Hours Start Time
327
441
  Enter 24 hour values with fractional values converted to minutes. e.g. 17.25 = 5:15pm. Only used if Modify weekend hours of operation is true.
328
442
  **Name:** wknd_op_hrs_start_time,
@@ -331,6 +445,7 @@ Enter 24 hour values with fractional values converted to minutes. e.g. 17.25 = 5
331
445
  **Required:** true,
332
446
  **Model Dependent:** false
333
447
 
448
+
334
449
  ### Weekend Operating Hours Duration
335
450
  Length of weekend operating hours. Enter 24 hour values with fractional values converted to minutes. e.g. 17.25 = 5:15pm. Only used if Modify weekend hours of operation is true.
336
451
  **Name:** wknd_op_hrs_duration,
@@ -339,6 +454,7 @@ Length of weekend operating hours. Enter 24 hour values with fractional values c
339
454
  **Required:** true,
340
455
  **Model Dependent:** false
341
456
 
457
+
342
458
  ### Unmet Hours Tolerance
343
459
  Set the thermostat setpoint tolerance for unmet hours in degrees Rankine
344
460
  **Name:** unmet_hours_tolerance,
@@ -347,6 +463,7 @@ Set the thermostat setpoint tolerance for unmet hours in degrees Rankine
347
463
  **Required:** true,
348
464
  **Model Dependent:** false
349
465
 
466
+
350
467
  ### Clean Model of non-geometry objects
351
468
  Only removes objects of type that are selected to be added.
352
469
  **Name:** remove_objects,
@@ -355,6 +472,7 @@ Only removes objects of type that are selected to be added.
355
472
  **Required:** true,
356
473
  **Model Dependent:** false
357
474
 
475
+
358
476
  ### Use Upstream Argument Values
359
477
  When true this will look for arguments or registerValues in upstream measures that match arguments from this measure, and will use the value from the upstream measure in place of what is entered for this measure.
360
478
  **Name:** use_upstream_args,
@@ -363,6 +481,7 @@ When true this will look for arguments or registerValues in upstream measures th
363
481
  **Required:** true,
364
482
  **Model Dependent:** false
365
483
 
484
+
366
485
  ### Enable Daylight Savings
367
486
  By default this will force daylight savings to be enabled. Set to false if in a location where DST is not followed, or if needed for specific use case.
368
487
  **Name:** enable_dst,
@@ -374,3 +493,4 @@ By default this will force daylight savings to be enabled. Set to false if in a
374
493
 
375
494
 
376
495
 
496
+
@@ -13,9 +13,9 @@
13
13
  ## Measure Type
14
14
  <%= measureType %>
15
15
 
16
- [//]: # (Commenting out until it works in SDK)
17
- [//]: # (## Taxonomy)
18
- [//]: # (<%= taxonomy %>)
16
+ [//]: # (Only finds value if taxonomy method is added to measure.rb, won't read out of measure.xml)
17
+ ## Taxonomy
18
+ <%= taxonomy %>
19
19
 
20
20
  ___
21
21
  ## Table of Contents
@@ -36,48 +36,46 @@ While this measure has many arguments, they all have default values so you can s
36
36
 
37
37
  ## DEER Template and Building Type Mapping
38
38
 
39
- - Templates:
40
- - DEER Pre-1975
41
- - DEER 1985
42
- - DEER 1996
43
- - DEER 2003
44
- - DEER 2007
45
- - DEER 2011
46
- - DEER 2014
47
- - DEER 2015
48
- - DEER 2017
49
- - DEER 2020
50
- - Building Types:
51
- - Asm
52
- - DMo
53
- - ECC
54
- - EPr
55
- - ERC
56
- - ESe
57
- - EUn
58
- - GHs
59
- - Gro
60
- - Hsp
61
- - Htl
62
- - MBT
63
- - MFm
64
- - MLI
65
- - Mtl
66
- - Nrs
67
- - OfL
68
- - OfS
69
- - RFF
70
- - RSD
71
- - Rt3
72
- - RtL
73
- - RtS
74
- - SCn
75
- - SFm
76
- - SUn
77
- - WRf
39
+ #### Templates:
40
+ <% arguments.each do |argument| %>
41
+ <% if argument[:name] == 'template'%>
42
+ <% argument[:choice_display_names].each do |choice|%>
43
+ - <%= choice %><br/>
44
+ <% end %>
45
+ <% end %>
46
+ <% end %>
47
+
48
+ #### Building Types:
49
+ - Asm
50
+ - DMo
51
+ - ECC
52
+ - EPr
53
+ - ERC
54
+ - ESe
55
+ - EUn
56
+ - GHs
57
+ - Gro
58
+ - Hsp
59
+ - Htl
60
+ - MBT
61
+ - MFm
62
+ - MLI
63
+ - Mtl
64
+ - Nrs
65
+ - OfL
66
+ - OfS
67
+ - RFF
68
+ - RSD
69
+ - Rt3
70
+ - RtL
71
+ - RtS
72
+ - SCn
73
+ - SFm
74
+ - SUn
75
+ - WRf
78
76
 
79
77
  [//]: # (Provide link to map DEER abbreviation to full building type name)
80
- [//]: # (Would be nice to make these lists dynamic from the measure to they don't become outdated)
78
+ [//]: # (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.)
81
79
 
82
80
  ## HVAC Configuration Arguments
83
81
 
@@ -101,16 +99,16 @@ While this measure has many arguments, they all have default values so you can s
101
99
 
102
100
  ## Bool Arguments to Enable/Disable Elements of This Measure
103
101
 
104
- The following is a list of aruments for elements of the model that can be enabled or disabled for the measure.
102
+ The following is a list of arguments for elements of the model that can be enabled or disabled for the measure.
105
103
  - `Add Constructions to Model`
106
104
  - `Add Space Type Loads to Model`
107
- - `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.
105
+ - `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.
108
106
  - `Add Internal Mass to Model`
109
107
  - `Add Exterior Lights to Model`
110
108
  - `Add Exhaust Fans to Model`
111
109
  - `Add Service Water Heating to Model`
112
110
  - `Add Thermostats`
113
- - `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.
111
+ - `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.
114
112
  - `Add Refrigeration to Model`
115
113
 
116
114
  ## Hours of Operation Arguments
@@ -124,19 +122,22 @@ There are three arguments each for weekday and weekend behavior. In each case th
124
122
 
125
123
  ## Other Arguments
126
124
 
127
- - `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.
125
+ - `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.
128
126
  - `Unmet Hours Tolerance` is used to change the tolerance used in EnergyPlus for unmet heating and cooling hours.
129
- - `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.
127
+ - `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.
130
128
  - `Enable Daylight Savings` will change daylighting saving to true when enabled.
131
129
 
132
130
  ## Development Comments
133
131
 
134
- 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.
135
- - os_lib_model_generation.rb
136
- - os_lib_helper_methods.rb
137
- - os_lib_helper_methods.rb
132
+ 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.
133
+ - os_lib_model_generation.rb
134
+ - os_lib_model_simplification.rb
135
+ - os_lib_geometry.rb
136
+ - os_lib_helper_methods.rb
137
+
138
+ *(Automatically generated argument information follows)*
138
139
 
139
- *(Automatically generated argument information follows)*## Arguments
140
+ ## Arguments
140
141
 
141
142
  <% arguments.each do |argument| %>
142
143
  ### <%= argument[:display_name] %>
@@ -146,6 +147,9 @@ This measure relies on the openstudio-standards gem which is included in the Ope
146
147
  **Units:** <%= argument[:units] %>,
147
148
  **Required:** <%= argument[:required] %>,
148
149
  **Model Dependent:** <%= argument[:model_dependent] %>
150
+ <% if argument[:type] == "Choice" && !argument[:model_dependent]%>
151
+ **Choice Display Names** <%= argument[:choice_display_names] %>
152
+ <% end %>
149
153
  <% end %>
150
154
 
151
155
  <% if arguments.size == 0 %>
@@ -66,6 +66,11 @@ class CreateTypicalDEERBuildingFromModel < OpenStudio::Measure::ModelMeasure
66
66
  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.'
67
67
  end
68
68
 
69
+ # used to populate taxonomy in readme.md
70
+ def taxonomy
71
+ return 'Whole Building.Space Types'
72
+ end
73
+
69
74
  # define the arguments that the user will input
70
75
  def arguments(model)
71
76
  args = OpenStudio::Measure::OSArgumentVector.new
@@ -80,7 +85,7 @@ class CreateTypicalDEERBuildingFromModel < OpenStudio::Measure::ModelMeasure
80
85
  end
81
86
 
82
87
  # Make argument for template
83
- template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', get_deer_templates, true)
88
+ template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', get_deer_templates(false), true)
84
89
  template.setDisplayName('Target Standard')
85
90
  template.setDefaultValue(default_string)
86
91
  args << template