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
@@ -45,7 +45,15 @@ Note, that this particular measure has access to both DOE and DEER templates (vi
45
45
  - 90.1-2007
46
46
  - 90.1-2010
47
47
  - 90.1-2013
48
+ - 90.1-2016
49
+ - 90.1-2019
48
50
  - NREL ZNE Ready 2017 (not currently complete for all building types)
51
+ - ComStock DOE Ref Pre-1980
52
+ - ComStock DOE Ref 1980-2004
53
+ - ComStock 90.1-2004
54
+ - ComStock 90.1-2007
55
+ - ComStock 90.1-2010
56
+ - ComStock 90.1-2013
49
57
  - Building Types:
50
58
  - SecondarySchool
51
59
  - PrimarySchool
@@ -64,6 +72,11 @@ Note, that this particular measure has access to both DOE and DEER templates (vi
64
72
  - Hospital
65
73
  - Outpatient
66
74
  - SuperMarket
75
+ - Laboratory
76
+ - LargeDataCenterLowITE
77
+ - LargeDataCenterHighITE
78
+ - SmallDataCenterLowITE
79
+ - SmallDataCenterHighITE
67
80
 
68
81
  #### DEER
69
82
  - Templates:
@@ -132,7 +145,7 @@ Note, that this particular measure has access to both DOE and DEER templates (vi
132
145
 
133
146
  - `Service Water Heating Source`can be set to `Inferred`, `NaturalGas`, `Electricity`, or `HeatPump`.
134
147
 
135
- - `Kitchen Exhaust MakeUp Air Calculation Method` is used to determine if makeup air is modeled for kitchen exhaust and what zone that comes from. While the default choice of `Adajcent` makes sence for custom user geometry, if the geometry was autogenerated without representing an actual plan, you can set makup air to come from the `Largest Zone`. `None` is also an option, which disables makeup air.
148
+ - `Kitchen Exhaust MakeUp Air Calculation Method` is used to determine if makeup air is modeled for kitchen exhaust and what zone that comes from. While the default choice of `Adajcent` makes sence for custom user geometry, if the geometry was autogenerated without representing an actual plan, you can set makeup air to come from the `Largest Zone`. `None` is also an option, which disables makeup air.
136
149
 
137
150
  ## Exterior Lighting Arguments
138
151
 
@@ -142,42 +155,46 @@ Note, that this particular measure has access to both DOE and DEER templates (vi
142
155
 
143
156
  ## Bool Arguments to Enable/Disable Elements of This Measure
144
157
 
145
- The following is a list of aruments for elements of the model that can be enabled or disabled for the measure.
158
+ The following is a list of arguments for elements of the model that can be enabled or disabled for the measure.
146
159
  - `Add Constructions to Model`
147
160
  - `Add Space Type Loads to Model`
148
- - `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.
161
+ - `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.
149
162
  - `Add Internal Mass to Model`
150
163
  - `Add Exterior Lights to Model`
151
164
  - `Add Exhaust Fans to Model`
152
165
  - `Add Service Water Heating to Model`
153
166
  - `Add Thermostats`
154
- - `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.
167
+ - `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.
155
168
  - `Add Refrigeration to Model`
156
169
 
157
170
  ## Hours of Operation Arguments
158
171
 
159
172
  There are three arguments each for weekday and weekend behavior. In each case there are the following arguments.
160
173
 
161
- - Bool argument to enable/dsiable altering of weekdays or weekends
174
+ - Bool argument to enable/disable altering of weekdays or weekends
162
175
  - Operating hours start time
163
176
  - Operating hours duration
164
177
 
165
178
  ## Other Arguments
166
179
 
167
- - `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.
168
- - `Climate Zone` is not used at all by this measure but is necessary for an obscure reason
180
+ - `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.
169
181
  - `Unmet Hours Tolerance` is used to change the tolerance used in EnergyPlus for unmet heating and cooling hours.
170
- - `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.
182
+ - `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.
171
183
  - `Enable Daylight Savings` will change daylighting saving to true when enabled.
172
184
 
173
185
  ## Development Comments
174
186
 
175
- 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.
176
- - os_lib_model_generation.rb
177
- - os_lib_helper_methods.rb
178
- - os_lib_helper_methods.rb
187
+ 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.
188
+ - os_lib_model_generation.rb
189
+ - os_lib_model_simplification.rb
190
+ - os_lib_geometry.rb
191
+ - os_lib_helper_methods.rb
179
192
 
180
- *(Automatically generated argument information follows)*## Arguments
193
+ ___
194
+
195
+ *(Automatically generated argument information follows)*
196
+
197
+ ## Arguments
181
198
 
182
199
 
183
200
  ### Target Standard
@@ -188,6 +205,9 @@ This measure relies on the openstudio-standards gem which is included in the Ope
188
205
  **Required:** true,
189
206
  **Model Dependent:** false
190
207
 
208
+ **Choice Display Names** ["DOE Ref Pre-1980", "DOE Ref 1980-2004", "90.1-2004", "90.1-2007", "90.1-2010", "90.1-2013", "90.1-2016", "90.1-2019", "ComStock DOE Ref Pre-1980", "ComStock DOE Ref 1980-2004", "ComStock 90.1-2004", "ComStock 90.1-2007", "ComStock 90.1-2010", "ComStock 90.1-2013", "DEER Pre-1975", "DEER 1985", "DEER 1996", "DEER 2003", "DEER 2007", "DEER 2011", "DEER 2014", "DEER 2015", "DEER 2017", "DEER 2020"]
209
+
210
+
191
211
  ### HVAC System Type
192
212
 
193
213
  **Name:** system_type,
@@ -196,6 +216,9 @@ This measure relies on the openstudio-standards gem which is included in the Ope
196
216
  **Required:** true,
197
217
  **Model Dependent:** false
198
218
 
219
+ **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"]
220
+
221
+
199
222
  ### HVAC System Delivery Type
200
223
  How the HVAC system delivers heating or cooling to the zone.
201
224
  **Name:** hvac_delivery_type,
@@ -204,6 +227,9 @@ How the HVAC system delivers heating or cooling to the zone.
204
227
  **Required:** true,
205
228
  **Model Dependent:** false
206
229
 
230
+ **Choice Display Names** ["Forced Air", "Hydronic"]
231
+
232
+
207
233
  ### HVAC Heating Source
208
234
  The primary source of heating used by HVAC systems in the model.
209
235
  **Name:** htg_src,
@@ -212,6 +238,9 @@ The primary source of heating used by HVAC systems in the model.
212
238
  **Required:** true,
213
239
  **Model Dependent:** false
214
240
 
241
+ **Choice Display Names** ["Electricity", "NaturalGas", "DistrictHeating", "DistrictAmbient"]
242
+
243
+
215
244
  ### HVAC Cooling Source
216
245
  The primary source of cooling used by HVAC systems in the model.
217
246
  **Name:** clg_src,
@@ -220,6 +249,9 @@ The primary source of cooling used by HVAC systems in the model.
220
249
  **Required:** true,
221
250
  **Model Dependent:** false
222
251
 
252
+ **Choice Display Names** ["Electricity", "DistrictCooling", "DistrictAmbient"]
253
+
254
+
223
255
  ### Service Water Heating Source
224
256
  The primary source of heating used by SWH systems in the model.
225
257
  **Name:** swh_src,
@@ -228,6 +260,9 @@ The primary source of heating used by SWH systems in the model.
228
260
  **Required:** true,
229
261
  **Model Dependent:** false
230
262
 
263
+ **Choice Display Names** ["Inferred", "NaturalGas", "Electricity", "HeatPump"]
264
+
265
+
231
266
  ### Kitchen Exhaust MakeUp Air Calculation Method
232
267
  Determine logic to identify dining or cafe zones to provide makeup air to kitchen exhaust.
233
268
  **Name:** kitchen_makeup,
@@ -236,6 +271,9 @@ Determine logic to identify dining or cafe zones to provide makeup air to kitche
236
271
  **Required:** true,
237
272
  **Model Dependent:** false
238
273
 
274
+ **Choice Display Names** ["None", "Largest Zone", "Adjacent"]
275
+
276
+
239
277
  ### Exterior Lighting Zone
240
278
  Identify the Exterior Lighting Zone for the Building Site.
241
279
  **Name:** exterior_lighting_zone,
@@ -244,6 +282,9 @@ Identify the Exterior Lighting Zone for the Building Site.
244
282
  **Required:** true,
245
283
  **Model Dependent:** false
246
284
 
285
+ **Choice Display Names** ["0 - Undeveloped Areas Parks", "1 - Developed Areas Parks", "2 - Neighborhood", "3 - All Other Areas", "4 - High Activity"]
286
+
287
+
247
288
  ### Add Constructions to Model
248
289
  Construction Set will be applied to entire building
249
290
  **Name:** add_constructions,
@@ -252,6 +293,7 @@ Construction Set will be applied to entire building
252
293
  **Required:** true,
253
294
  **Model Dependent:** false
254
295
 
296
+
255
297
  ### Add Space Type Loads to Model
256
298
  Populate existing space types in model with internal loads.
257
299
  **Name:** add_space_type_loads,
@@ -260,6 +302,7 @@ Populate existing space types in model with internal loads.
260
302
  **Required:** true,
261
303
  **Model Dependent:** false
262
304
 
305
+
263
306
  ### Add Elevators to Model
264
307
  Elevators will be add directly to space in model vs. being applied to a space type.
265
308
  **Name:** add_elevators,
@@ -268,6 +311,7 @@ Elevators will be add directly to space in model vs. being applied to a space ty
268
311
  **Required:** true,
269
312
  **Model Dependent:** false
270
313
 
314
+
271
315
  ### Add Internal Mass to Model
272
316
  Adds internal mass to each space.
273
317
  **Name:** add_internal_mass,
@@ -276,6 +320,7 @@ Adds internal mass to each space.
276
320
  **Required:** true,
277
321
  **Model Dependent:** false
278
322
 
323
+
279
324
  ### Add Exterior Lights to Model
280
325
  Multiple exterior lights objects will be added for different classes of lighting such as parking and facade.
281
326
  **Name:** add_exterior_lights,
@@ -284,6 +329,7 @@ Multiple exterior lights objects will be added for different classes of lighting
284
329
  **Required:** true,
285
330
  **Model Dependent:** false
286
331
 
332
+
287
333
  ### Onsite Parking Fraction
288
334
  If set to 0 no exterior lighting for parking will be added
289
335
  **Name:** onsite_parking_fraction,
@@ -292,6 +338,7 @@ If set to 0 no exterior lighting for parking will be added
292
338
  **Required:** true,
293
339
  **Model Dependent:** false
294
340
 
341
+
295
342
  ### Add Exhaust Fans to Model
296
343
  Depending upon building type exhaust fans can be in kitchens, restrooms or other space types
297
344
  **Name:** add_exhaust,
@@ -300,6 +347,7 @@ Depending upon building type exhaust fans can be in kitchens, restrooms or other
300
347
  **Required:** true,
301
348
  **Model Dependent:** false
302
349
 
350
+
303
351
  ### Add Service Water Heating to Model
304
352
  This will add both the supply and demand side of service water heating.
305
353
  **Name:** add_swh,
@@ -308,6 +356,7 @@ This will add both the supply and demand side of service water heating.
308
356
  **Required:** true,
309
357
  **Model Dependent:** false
310
358
 
359
+
311
360
  ### Add Thermostats
312
361
  Add Thermostat to model based on Space Type Standards information of spaces assigned to thermal zones.
313
362
  **Name:** add_thermostat,
@@ -316,6 +365,7 @@ Add Thermostat to model based on Space Type Standards information of spaces assi
316
365
  **Required:** true,
317
366
  **Model Dependent:** false
318
367
 
368
+
319
369
  ### Add HVAC System to Model
320
370
  Add HVAC System to the model
321
371
  **Name:** add_hvac,
@@ -324,6 +374,7 @@ Add HVAC System to the model
324
374
  **Required:** true,
325
375
  **Model Dependent:** false
326
376
 
377
+
327
378
  ### Add Refrigeration to Model
328
379
  Add refrigeration cases and walkins model
329
380
  **Name:** add_refrigeration,
@@ -332,6 +383,7 @@ Add refrigeration cases and walkins model
332
383
  **Required:** true,
333
384
  **Model Dependent:** false
334
385
 
386
+
335
387
  ### Modify weekday hours of operation
336
388
  Modify the weekday hours of operation in the model.
337
389
  **Name:** modify_wkdy_op_hrs,
@@ -340,6 +392,7 @@ Modify the weekday hours of operation in the model.
340
392
  **Required:** true,
341
393
  **Model Dependent:** false
342
394
 
395
+
343
396
  ### Weekday Operating Hours Start Time
344
397
  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.
345
398
  **Name:** wkdy_op_hrs_start_time,
@@ -348,6 +401,7 @@ Enter 24 hour values with fractional values converted to minutes. e.g. 17.25 = 5
348
401
  **Required:** true,
349
402
  **Model Dependent:** false
350
403
 
404
+
351
405
  ### Weekday Operating Hours Duration
352
406
  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.
353
407
  **Name:** wkdy_op_hrs_duration,
@@ -356,6 +410,7 @@ Length of weekday operating hours. Enter 24 hour values with fractional values c
356
410
  **Required:** true,
357
411
  **Model Dependent:** false
358
412
 
413
+
359
414
  ### Modify weekend hours of operation
360
415
  Modify the weekend hours of operation in the model.
361
416
  **Name:** modify_wknd_op_hrs,
@@ -364,6 +419,7 @@ Modify the weekend hours of operation in the model.
364
419
  **Required:** true,
365
420
  **Model Dependent:** false
366
421
 
422
+
367
423
  ### Weekend Operating Hours Start Time
368
424
  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.
369
425
  **Name:** wknd_op_hrs_start_time,
@@ -372,6 +428,7 @@ Enter 24 hour values with fractional values converted to minutes. e.g. 17.25 = 5
372
428
  **Required:** true,
373
429
  **Model Dependent:** false
374
430
 
431
+
375
432
  ### Weekend Operating Hours Duration
376
433
  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.
377
434
  **Name:** wknd_op_hrs_duration,
@@ -380,6 +437,7 @@ Length of weekend operating hours. Enter 24 hour values with fractional values c
380
437
  **Required:** true,
381
438
  **Model Dependent:** false
382
439
 
440
+
383
441
  ### Unmet Hours Tolerance
384
442
  Set the thermostat setpoint tolerance for unmet hours in degrees Rankine
385
443
  **Name:** unmet_hours_tolerance,
@@ -388,6 +446,7 @@ Set the thermostat setpoint tolerance for unmet hours in degrees Rankine
388
446
  **Required:** true,
389
447
  **Model Dependent:** false
390
448
 
449
+
391
450
  ### Clean Model of non-geometry objects
392
451
  Only removes objects of type that are selected to be added.
393
452
  **Name:** remove_objects,
@@ -396,6 +455,7 @@ Only removes objects of type that are selected to be added.
396
455
  **Required:** true,
397
456
  **Model Dependent:** false
398
457
 
458
+
399
459
  ### Use Upstream Argument Values
400
460
  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.
401
461
  **Name:** use_upstream_args,
@@ -404,6 +464,7 @@ When true this will look for arguments or registerValues in upstream measures th
404
464
  **Required:** true,
405
465
  **Model Dependent:** false
406
466
 
467
+
407
468
  ### Enable Daylight Savings
408
469
  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.
409
470
  **Name:** enable_dst,
@@ -412,6 +473,7 @@ By default this will force daylight savings to be enabled. Set to false if in a
412
473
  **Required:** true,
413
474
  **Model Dependent:** false
414
475
 
476
+
415
477
  ### Climate Zone.
416
478
 
417
479
  **Name:** climate_zone,
@@ -420,6 +482,9 @@ By default this will force daylight savings to be enabled. Set to false if in a
420
482
  **Required:** true,
421
483
  **Model Dependent:** false
422
484
 
485
+ **Choice Display Names** ["Lookup From Model", "ASHRAE 169-2013-1A", "ASHRAE 169-2013-1B", "ASHRAE 169-2013-2A", "ASHRAE 169-2013-2B", "ASHRAE 169-2013-3A", "ASHRAE 169-2013-3B", "ASHRAE 169-2013-3C", "ASHRAE 169-2013-4A", "ASHRAE 169-2013-4B", "ASHRAE 169-2013-4C", "ASHRAE 169-2013-5A", "ASHRAE 169-2013-5B", "ASHRAE 169-2013-5C", "ASHRAE 169-2013-6A", "ASHRAE 169-2013-6B", "ASHRAE 169-2013-7A", "ASHRAE 169-2013-8A", "CEC T24-CEC1", "CEC T24-CEC2", "CEC T24-CEC3", "CEC T24-CEC4", "CEC T24-CEC5", "CEC T24-CEC6", "CEC T24-CEC7", "CEC T24-CEC8", "CEC T24-CEC9", "CEC T24-CEC10", "CEC T24-CEC11", "CEC T24-CEC12", "CEC T24-CEC13", "CEC T24-CEC14", "CEC T24-CEC15", "CEC T24-CEC16"]
486
+
487
+
423
488
 
424
489
 
425
490
 
@@ -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
@@ -45,7 +45,15 @@ Note, that this particular measure has access to both DOE and DEER templates (vi
45
45
  - 90.1-2007
46
46
  - 90.1-2010
47
47
  - 90.1-2013
48
+ - 90.1-2016
49
+ - 90.1-2019
48
50
  - NREL ZNE Ready 2017 (not currently complete for all building types)
51
+ - ComStock DOE Ref Pre-1980
52
+ - ComStock DOE Ref 1980-2004
53
+ - ComStock 90.1-2004
54
+ - ComStock 90.1-2007
55
+ - ComStock 90.1-2010
56
+ - ComStock 90.1-2013
49
57
  - Building Types:
50
58
  - SecondarySchool
51
59
  - PrimarySchool
@@ -64,6 +72,11 @@ Note, that this particular measure has access to both DOE and DEER templates (vi
64
72
  - Hospital
65
73
  - Outpatient
66
74
  - SuperMarket
75
+ - Laboratory
76
+ - LargeDataCenterLowITE
77
+ - LargeDataCenterHighITE
78
+ - SmallDataCenterLowITE
79
+ - SmallDataCenterHighITE
67
80
 
68
81
  #### DEER
69
82
  - Templates:
@@ -132,7 +145,7 @@ Note, that this particular measure has access to both DOE and DEER templates (vi
132
145
 
133
146
  - `Service Water Heating Source`can be set to `Inferred`, `NaturalGas`, `Electricity`, or `HeatPump`.
134
147
 
135
- - `Kitchen Exhaust MakeUp Air Calculation Method` is used to determine if makeup air is modeled for kitchen exhaust and what zone that comes from. While the default choice of `Adajcent` makes sence for custom user geometry, if the geometry was autogenerated without representing an actual plan, you can set makup air to come from the `Largest Zone`. `None` is also an option, which disables makeup air.
148
+ - `Kitchen Exhaust MakeUp Air Calculation Method` is used to determine if makeup air is modeled for kitchen exhaust and what zone that comes from. While the default choice of `Adajcent` makes sence for custom user geometry, if the geometry was autogenerated without representing an actual plan, you can set makeup air to come from the `Largest Zone`. `None` is also an option, which disables makeup air.
136
149
 
137
150
  ## Exterior Lighting Arguments
138
151
 
@@ -142,42 +155,46 @@ Note, that this particular measure has access to both DOE and DEER templates (vi
142
155
 
143
156
  ## Bool Arguments to Enable/Disable Elements of This Measure
144
157
 
145
- The following is a list of aruments for elements of the model that can be enabled or disabled for the measure.
158
+ The following is a list of arguments for elements of the model that can be enabled or disabled for the measure.
146
159
  - `Add Constructions to Model`
147
160
  - `Add Space Type Loads to Model`
148
- - `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.
161
+ - `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.
149
162
  - `Add Internal Mass to Model`
150
163
  - `Add Exterior Lights to Model`
151
164
  - `Add Exhaust Fans to Model`
152
165
  - `Add Service Water Heating to Model`
153
166
  - `Add Thermostats`
154
- - `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.
167
+ - `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.
155
168
  - `Add Refrigeration to Model`
156
169
 
157
170
  ## Hours of Operation Arguments
158
171
 
159
172
  There are three arguments each for weekday and weekend behavior. In each case there are the following arguments.
160
173
 
161
- - Bool argument to enable/dsiable altering of weekdays or weekends
174
+ - Bool argument to enable/disable altering of weekdays or weekends
162
175
  - Operating hours start time
163
176
  - Operating hours duration
164
177
 
165
178
  ## Other Arguments
166
179
 
167
- - `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.
168
- - `Climate Zone` is not used at all by this measure but is necessary for an obscure reason
180
+ - `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.
169
181
  - `Unmet Hours Tolerance` is used to change the tolerance used in EnergyPlus for unmet heating and cooling hours.
170
- - `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.
182
+ - `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.
171
183
  - `Enable Daylight Savings` will change daylighting saving to true when enabled.
172
184
 
173
185
  ## Development Comments
174
186
 
175
- 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.
176
- - os_lib_model_generation.rb
177
- - os_lib_helper_methods.rb
178
- - os_lib_helper_methods.rb
187
+ 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.
188
+ - os_lib_model_generation.rb
189
+ - os_lib_model_simplification.rb
190
+ - os_lib_geometry.rb
191
+ - os_lib_helper_methods.rb
179
192
 
180
- *(Automatically generated argument information follows)*## Arguments
193
+ ___
194
+
195
+ *(Automatically generated argument information follows)*
196
+
197
+ ## Arguments
181
198
 
182
199
  <% arguments.each do |argument| %>
183
200
  ### <%= argument[:display_name] %>
@@ -187,6 +204,9 @@ This measure relies on the openstudio-standards gem which is included in the Ope
187
204
  **Units:** <%= argument[:units] %>,
188
205
  **Required:** <%= argument[:required] %>,
189
206
  **Model Dependent:** <%= argument[:model_dependent] %>
207
+ <% if argument[:type] == "Choice" && !argument[:model_dependent]%>
208
+ **Choice Display Names** <%= argument[:choice_display_names] %>
209
+ <% end %>
190
210
  <% end %>
191
211
 
192
212
  <% if arguments.size == 0 %>
@@ -63,6 +63,11 @@ class CreateTypicalBuildingFromModel < OpenStudio::Measure::ModelMeasure
63
63
  return 'It is important that the template argument chosen for this measure is in line with the building types for the stub space types of the model passed in.'
64
64
  end
65
65
 
66
+ # used to populate taxonomy in readme.md
67
+ def taxonomy
68
+ return 'Whole Building.Space Types'
69
+ end
70
+
66
71
  # define the arguments that the user will input
67
72
  def arguments(model)
68
73
  args = OpenStudio::Measure::OSArgumentVector.new
@@ -3,8 +3,8 @@
3
3
  <schema_version>3.0</schema_version>
4
4
  <name>create_typical_building_from_model</name>
5
5
  <uid>339a2e3a-273c-4494-bb50-bfe586a0647c</uid>
6
- <version_id>e3107c46-fbd4-40af-aad5-352759b547ec</version_id>
7
- <version_modified>20210423T142533Z</version_modified>
6
+ <version_id>97112603-b027-4802-9310-d0e02b78200d</version_id>
7
+ <version_modified>20210716T214830Z</version_modified>
8
8
  <xml_checksum>EE13F09F</xml_checksum>
9
9
  <class_name>CreateTypicalBuildingFromModel</class_name>
10
10
  <display_name>Create Typical Building from Model</display_name>
@@ -1538,18 +1538,6 @@
1538
1538
  <usage_type>test</usage_type>
1539
1539
  <checksum>F22DEFBC</checksum>
1540
1540
  </file>
1541
- <file>
1542
- <filename>README.md.erb</filename>
1543
- <filetype>erb</filetype>
1544
- <usage_type>readmeerb</usage_type>
1545
- <checksum>9CCCA1AC</checksum>
1546
- </file>
1547
- <file>
1548
- <filename>README.md</filename>
1549
- <filetype>md</filetype>
1550
- <usage_type>readme</usage_type>
1551
- <checksum>EC286BBD</checksum>
1552
- </file>
1553
1541
  <file>
1554
1542
  <filename>LICENSE.md</filename>
1555
1543
  <filetype>md</filetype>
@@ -1568,6 +1556,18 @@
1568
1556
  <usage_type>test</usage_type>
1569
1557
  <checksum>1C2C0385</checksum>
1570
1558
  </file>
1559
+ <file>
1560
+ <filename>Model.hvac.rb</filename>
1561
+ <filetype>rb</filetype>
1562
+ <usage_type>resource</usage_type>
1563
+ <checksum>32C64B0B</checksum>
1564
+ </file>
1565
+ <file>
1566
+ <filename>README.md.erb</filename>
1567
+ <filetype>erb</filetype>
1568
+ <usage_type>readmeerb</usage_type>
1569
+ <checksum>6A400402</checksum>
1570
+ </file>
1571
1571
  <file>
1572
1572
  <version>
1573
1573
  <software_program>OpenStudio</software_program>
@@ -1577,13 +1577,13 @@
1577
1577
  <filename>measure.rb</filename>
1578
1578
  <filetype>rb</filetype>
1579
1579
  <usage_type>script</usage_type>
1580
- <checksum>D9B1DE15</checksum>
1580
+ <checksum>D98EF78A</checksum>
1581
1581
  </file>
1582
1582
  <file>
1583
- <filename>Model.hvac.rb</filename>
1584
- <filetype>rb</filetype>
1585
- <usage_type>resource</usage_type>
1586
- <checksum>32C64B0B</checksum>
1583
+ <filename>README.md</filename>
1584
+ <filetype>md</filetype>
1585
+ <usage_type>readme</usage_type>
1586
+ <checksum>AC908059</checksum>
1587
1587
  </file>
1588
1588
  </files>
1589
1589
  </measure>