openstudio-geb 0.5.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +7 -3
  3. data/CHANGELOG.md +7 -0
  4. data/Gemfile +1 -12
  5. data/files/seasonal_shedding_peak_hours.json +1 -0
  6. data/files/seasonal_shifting_peak_hours.json +1 -0
  7. data/files/seasonal_shifting_take_hours.json +1 -0
  8. data/lib/measures/AddElectricVehicleChargingLoad/README.md +16 -0
  9. data/lib/measures/AddElectricVehicleChargingLoad/measure.xml +64 -32
  10. data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/README.md +266 -42
  11. data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/measure.rb +963 -442
  12. data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/measure.xml +330 -95
  13. data/lib/measures/GEB Metrics Report/README.md +41 -1
  14. data/lib/measures/GEB Metrics Report/measure.xml +84 -241
  15. data/lib/measures/GEB Metrics Report/resources/os_lib_reporting.rb +5 -5
  16. data/lib/measures/add_ceiling_fan/measure.rb +2 -2
  17. data/lib/measures/add_ceiling_fan/measure.xml +30 -30
  18. data/lib/measures/add_chilled_water_storage_tank/README.md +73 -33
  19. data/lib/measures/add_chilled_water_storage_tank/measure.rb +5 -0
  20. data/lib/measures/add_chilled_water_storage_tank/measure.xml +23 -23
  21. data/lib/measures/add_chilled_water_storage_tank/tests/370_medium_office_doas_fan_coil_acc_boiler_3A.osm +31800 -0
  22. data/lib/measures/add_chilled_water_storage_tank/tests/LargeOffice-90.1-2013-ASHRAE 169-2013-5A.osm +22036 -0
  23. data/lib/measures/add_exterior_blinds_and_control/measure.xml +28 -28
  24. data/lib/measures/add_fan_assist_night_ventilation_with_hybrid_control/measure.rb +5 -0
  25. data/lib/measures/add_fan_assist_night_ventilation_with_hybrid_control/measure.xml +20 -44
  26. data/lib/measures/add_heat_pump_water_heater/measure.rb +28 -28
  27. data/lib/measures/add_heat_pump_water_heater/measure.xml +30 -95
  28. data/lib/measures/add_interior_blinds_and_control/measure.xml +28 -28
  29. data/lib/measures/add_rooftop_pv_simple/measure.rb +1 -1
  30. data/lib/measures/add_rooftop_pv_simple/measure.xml +24 -24
  31. data/lib/measures/apply_dynamic_coating_to_roof_wall/LICENSE.md +13 -1
  32. data/lib/measures/apply_dynamic_coating_to_roof_wall/measure.rb +7 -2
  33. data/lib/measures/apply_dynamic_coating_to_roof_wall/measure.xml +20 -14
  34. data/lib/measures/apply_dynamic_coating_to_roof_wall/tests/SFD_1story_UB_UA_ASHP2_HPWH.osm +13110 -0
  35. data/lib/measures/apply_dynamic_coating_to_roof_wall/tests/apply_dynamic_coating_to_roof_wall_test.rb +5 -0
  36. data/lib/measures/average_ventilation_for_peak_hours/measure.xml +20 -20
  37. data/lib/measures/enable_occupancy_driven_lighting/measure.xml +28 -28
  38. data/lib/measures/precooling/README.md +137 -17
  39. data/lib/measures/precooling/measure.rb +964 -354
  40. data/lib/measures/precooling/measure.xml +172 -44
  41. data/lib/measures/preheating/README.md +125 -21
  42. data/lib/measures/preheating/measure.rb +940 -356
  43. data/lib/measures/preheating/measure.xml +160 -50
  44. data/lib/measures/reduce_epd_by_percentage_for_peak_hours/README.md +125 -29
  45. data/lib/measures/reduce_epd_by_percentage_for_peak_hours/measure.rb +509 -300
  46. data/lib/measures/reduce_epd_by_percentage_for_peak_hours/measure.xml +178 -70
  47. data/lib/measures/reduce_lpd_by_percentage_for_peak_hours/README.md +132 -28
  48. data/lib/measures/reduce_lpd_by_percentage_for_peak_hours/measure.rb +534 -309
  49. data/lib/measures/reduce_lpd_by_percentage_for_peak_hours/measure.xml +186 -69
  50. data/lib/openstudio/geb/version.rb +1 -1
  51. data/openstudio-geb.gemspec +5 -5
  52. metadata +31 -25
data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/README.md CHANGED
@@ -19,124 +19,348 @@ ModelMeasure
19
19
  ## Arguments
20
20
 
21
21
 
22
- ### Degrees Fahrenheit to Adjust Cooling Setpoint By
22
+ ### Degrees Fahrenheit to Adjust heating Setpoint By
23
23
 
24
- **Name:** cooling_adjustment,
24
+ **Name:** heating_adjustment,
25
25
  **Type:** Double,
26
26
  **Units:** ,
27
27
  **Required:** true,
28
28
  **Model Dependent:** false
29
29
 
30
- ### Daily Start Time for Cooling Adjustment
31
- Use 24 hour format HH:MM:SS
32
- **Name:** cooling_daily_starttime,
30
+ ### First start date for heating setpoint adjustment
31
+ In MM-DD format
32
+ **Name:** heating_start_date1,
33
+ **Type:** String,
34
+ **Units:** ,
35
+ **Required:** true,
36
+ **Model Dependent:** false
37
+
38
+ ### First end date for heating setpoint adjustment
39
+ In MM-DD format
40
+ **Name:** heating_end_date1,
41
+ **Type:** String,
42
+ **Units:** ,
43
+ **Required:** true,
44
+ **Model Dependent:** false
45
+
46
+ ### Second start date for heating setpoint adjustment (optional)
47
+ Specify a date in MM-DD format if you want a second season of heating setpoint adjustment; leave blank if not needed.
48
+ **Name:** heating_start_date2,
33
49
  **Type:** String,
34
50
  **Units:** ,
35
51
  **Required:** false,
36
52
  **Model Dependent:** false
37
53
 
38
- ### Daily End Time for Cooling Adjustment
39
- Use 24 hour format HH:MM:SS
40
- **Name:** cooling_daily_endtime,
54
+ ### Second end date for heating setpoint adjustment
55
+ Specify a date in MM-DD format if you want a second season of heating setpoint adjustment; leave blank if not needed. If either the start or end date is blank, the period is considered not used.
56
+ **Name:** heating_end_date2,
41
57
  **Type:** String,
42
58
  **Units:** ,
43
59
  **Required:** false,
44
60
  **Model Dependent:** false
45
61
 
46
- ### Start Date for Cooling Adjustment
47
- In MM-DD format
48
- **Name:** cooling_startdate,
62
+ ### Third start date for heating setpoint adjustment (optional)
63
+ Specify a date in MM-DD format if you want a third season of heating setpoint adjustment; leave blank if not needed.
64
+ **Name:** heating_start_date3,
49
65
  **Type:** String,
50
66
  **Units:** ,
51
67
  **Required:** false,
52
68
  **Model Dependent:** false
53
69
 
54
- ### End Date for Cooling Adjustment
55
- In MM-DD format
56
- **Name:** cooling_enddate,
70
+ ### Third end date for heating setpoint adjustment
71
+ Specify a date in MM-DD format if you want a third season of heating setpoint adjustment; leave blank if not needed. If either the start or end date is blank, the period is considered not used.
72
+ **Name:** heating_end_date3,
57
73
  **Type:** String,
58
74
  **Units:** ,
59
75
  **Required:** false,
60
76
  **Model Dependent:** false
61
77
 
62
- ### Degrees Fahrenheit to Adjust heating Setpoint By
78
+ ### Fourth start date for heating setpoint adjustment (optional)
79
+ Specify a date in MM-DD format if you want a fourth season of heating setpoint adjustment; leave blank if not needed.
80
+ **Name:** heating_start_date4,
81
+ **Type:** String,
82
+ **Units:** ,
83
+ **Required:** false,
84
+ **Model Dependent:** false
63
85
 
64
- **Name:** heating_adjustment,
65
- **Type:** Double,
86
+ ### Fourth end date for heating setpoint adjustment
87
+ Specify a date in MM-DD format if you want a fourth season of heating setpoint adjustment; leave blank if not needed. If either the start or end date is blank, the period is considered not used.
88
+ **Name:** heating_end_date4,
89
+ **Type:** String,
90
+ **Units:** ,
91
+ **Required:** false,
92
+ **Model Dependent:** false
93
+
94
+ ### Fifth start date for heating setpoint adjustment (optional)
95
+ Specify a date in MM-DD format if you want a fifth season of heating setpoint adjustment; leave blank if not needed.
96
+ **Name:** heating_start_date5,
97
+ **Type:** String,
98
+ **Units:** ,
99
+ **Required:** false,
100
+ **Model Dependent:** false
101
+
102
+ ### Fifth end date for heating setpoint adjustment
103
+ Specify a date in MM-DD format if you want a fifth season of heating setpoint adjustment; leave blank if not needed. If either the start or end date is blank, the period is considered not used.
104
+ **Name:** heating_end_date5,
105
+ **Type:** String,
106
+ **Units:** ,
107
+ **Required:** false,
108
+ **Model Dependent:** false
109
+
110
+ ### Start time of heating setpoint adjustment for the first season
111
+ In HH:MM:SS format
112
+ **Name:** heating_start_time1,
113
+ **Type:** String,
66
114
  **Units:** ,
67
115
  **Required:** true,
68
116
  **Model Dependent:** false
69
117
 
70
- ### Start Time for Heating Adjustment
71
- Use 24 hour format HH:MM:SS
72
- **Name:** heating_daily_starttime,
118
+ ### End time of heating setpoint adjustment for the first season
119
+ In HH:MM:SS format
120
+ **Name:** heating_end_time1,
121
+ **Type:** String,
122
+ **Units:** ,
123
+ **Required:** true,
124
+ **Model Dependent:** false
125
+
126
+ ### Start time of heating setpoint adjustment for the second season (optional)
127
+ In HH:MM:SS format
128
+ **Name:** heating_start_time2,
73
129
  **Type:** String,
74
130
  **Units:** ,
75
131
  **Required:** false,
76
132
  **Model Dependent:** false
77
133
 
78
- ### End Time for Heating Adjustment
79
- Use 24 hour format HH:MM:SS
80
- **Name:** heating_daily_endtime,
134
+ ### End time of heating setpoint adjustment for the second season (optional)
135
+ In HH:MM:SS format
136
+ **Name:** heating_end_time2,
81
137
  **Type:** String,
82
138
  **Units:** ,
83
139
  **Required:** false,
84
140
  **Model Dependent:** false
85
141
 
86
- ### Start Date for Heating Adjustment Period 1
87
- In MM-DD format
88
- **Name:** heating_startdate_1,
142
+ ### Start time of heating setpoint adjustment for the third season (optional)
143
+ In HH:MM:SS format
144
+ **Name:** heating_start_time3,
89
145
  **Type:** String,
90
146
  **Units:** ,
91
147
  **Required:** false,
92
148
  **Model Dependent:** false
93
149
 
94
- ### End Date for Heating Adjustment Period 1
95
- In MM-DD format
96
- **Name:** heating_enddate_1,
150
+ ### End time of heating setpoint adjustment for the third season (optional)
151
+ In HH:MM:SS format
152
+ **Name:** heating_end_time3,
97
153
  **Type:** String,
98
154
  **Units:** ,
99
155
  **Required:** false,
100
156
  **Model Dependent:** false
101
157
 
102
- ### Start Date for Heating Adjustment Period 2
103
- In MM-DD format
104
- **Name:** heating_startdate_2,
158
+ ### Start time of heating setpoint adjustment for the fourth season (optional)
159
+ In HH:MM:SS format
160
+ **Name:** heating_start_time4,
161
+ **Type:** String,
162
+ **Units:** ,
163
+ **Required:** false,
164
+ **Model Dependent:** false
165
+
166
+ ### End time of heating setpoint adjustment for the fourth season (optional)
167
+ In HH:MM:SS format
168
+ **Name:** heating_end_time4,
169
+ **Type:** String,
170
+ **Units:** ,
171
+ **Required:** false,
172
+ **Model Dependent:** false
173
+
174
+ ### Start time of heating setpoint adjustment for the fifth season (optional)
175
+ In HH:MM:SS format
176
+ **Name:** heating_start_time5,
177
+ **Type:** String,
178
+ **Units:** ,
179
+ **Required:** false,
180
+ **Model Dependent:** false
181
+
182
+ ### End time of heating setpoint adjustment for the fifth season (optional)
183
+ In HH:MM:SS format
184
+ **Name:** heating_end_time5,
105
185
  **Type:** String,
106
186
  **Units:** ,
107
187
  **Required:** false,
108
188
  **Model Dependent:** false
109
189
 
110
- ### End Date for Heating Adjustment Period 2
190
+ ### Degrees Fahrenheit to Adjust Cooling Setpoint By
191
+
192
+ **Name:** cooling_adjustment,
193
+ **Type:** Double,
194
+ **Units:** ,
195
+ **Required:** true,
196
+ **Model Dependent:** false
197
+
198
+ ### First start date for cooling setpoint adjustment
199
+ In MM-DD format
200
+ **Name:** cooling_start_date1,
201
+ **Type:** String,
202
+ **Units:** ,
203
+ **Required:** true,
204
+ **Model Dependent:** false
205
+
206
+ ### First end date for cooling setpoint adjustment
111
207
  In MM-DD format
112
- **Name:** heating_enddate_2,
208
+ **Name:** cooling_end_date1,
209
+ **Type:** String,
210
+ **Units:** ,
211
+ **Required:** true,
212
+ **Model Dependent:** false
213
+
214
+ ### Second start date for cooling setpoint adjustment (optional)
215
+ Specify a date in MM-DD format if you want a second season of cooling setpoint adjustment; leave blank if not needed.
216
+ **Name:** cooling_start_date2,
113
217
  **Type:** String,
114
218
  **Units:** ,
115
219
  **Required:** false,
116
220
  **Model Dependent:** false
117
221
 
118
- ### Alter Design Day Thermostats
222
+ ### Second end date for cooling setpoint adjustment
223
+ Specify a date in MM-DD format if you want a second season of cooling setpoint adjustment; leave blank if not needed. If either the start or end date is blank, the period is considered not used.
224
+ **Name:** cooling_end_date2,
225
+ **Type:** String,
226
+ **Units:** ,
227
+ **Required:** false,
228
+ **Model Dependent:** false
119
229
 
120
- **Name:** alter_design_days,
121
- **Type:** Boolean,
230
+ ### Third start date for cooling setpoint adjustment (optional)
231
+ Specify a date in MM-DD format if you want a third season of cooling setpoint adjustment; leave blank if not needed.
232
+ **Name:** cooling_start_date3,
233
+ **Type:** String,
234
+ **Units:** ,
235
+ **Required:** false,
236
+ **Model Dependent:** false
237
+
238
+ ### Third end date for cooling setpoint adjustment
239
+ Specify a date in MM-DD format if you want a third season of cooling setpoint adjustment; leave blank if not needed. If either the start or end date is blank, the period is considered not used.
240
+ **Name:** cooling_end_date3,
241
+ **Type:** String,
122
242
  **Units:** ,
123
243
  **Required:** false,
124
244
  **Model Dependent:** false
125
245
 
126
- ### Enable Climate-specific Periods Setting?
246
+ ### Fourth start date for cooling setpoint adjustment (optional)
247
+ Specify a date in MM-DD format if you want a fourth season of cooling setpoint adjustment; leave blank if not needed.
248
+ **Name:** cooling_start_date4,
249
+ **Type:** String,
250
+ **Units:** ,
251
+ **Required:** false,
252
+ **Model Dependent:** false
127
253
 
128
- **Name:** auto_date,
129
- **Type:** Boolean,
254
+ ### Fourth end date for cooling setpoint adjustment
255
+ Specify a date in MM-DD format if you want a fourth season of cooling setpoint adjustment; leave blank if not needed. If either the start or end date is blank, the period is considered not used.
256
+ **Name:** cooling_end_date4,
257
+ **Type:** String,
258
+ **Units:** ,
259
+ **Required:** false,
260
+ **Model Dependent:** false
261
+
262
+ ### Fifth start date for cooling setpoint adjustment (optional)
263
+ Specify a date in MM-DD format if you want a fifth season of cooling setpoint adjustment; leave blank if not needed.
264
+ **Name:** cooling_start_date5,
265
+ **Type:** String,
266
+ **Units:** ,
267
+ **Required:** false,
268
+ **Model Dependent:** false
269
+
270
+ ### Fifth end date for cooling setpoint adjustment
271
+ Specify a date in MM-DD format if you want a fifth season of cooling setpoint adjustment; leave blank if not needed. If either the start or end date is blank, the period is considered not used.
272
+ **Name:** cooling_end_date5,
273
+ **Type:** String,
274
+ **Units:** ,
275
+ **Required:** false,
276
+ **Model Dependent:** false
277
+
278
+ ### Start time of cooling setpoint adjustment for the first season
279
+ In HH:MM:SS format
280
+ **Name:** cooling_start_time1,
281
+ **Type:** String,
282
+ **Units:** ,
283
+ **Required:** true,
284
+ **Model Dependent:** false
285
+
286
+ ### End time of cooling setpoint adjustment for the first season
287
+ In HH:MM:SS format
288
+ **Name:** cooling_end_time1,
289
+ **Type:** String,
290
+ **Units:** ,
291
+ **Required:** true,
292
+ **Model Dependent:** false
293
+
294
+ ### Start time of cooling setpoint adjustment for the second season (optional)
295
+ In HH:MM:SS format
296
+ **Name:** cooling_start_time2,
297
+ **Type:** String,
298
+ **Units:** ,
299
+ **Required:** false,
300
+ **Model Dependent:** false
301
+
302
+ ### End time of cooling setpoint adjustment for the second season (optional)
303
+ In HH:MM:SS format
304
+ **Name:** cooling_end_time2,
305
+ **Type:** String,
306
+ **Units:** ,
307
+ **Required:** false,
308
+ **Model Dependent:** false
309
+
310
+ ### Start time of cooling setpoint adjustment for the third season (optional)
311
+ In HH:MM:SS format
312
+ **Name:** cooling_start_time3,
313
+ **Type:** String,
314
+ **Units:** ,
315
+ **Required:** false,
316
+ **Model Dependent:** false
317
+
318
+ ### End time of cooling setpoint adjustment for the third season (optional)
319
+ In HH:MM:SS format
320
+ **Name:** cooling_end_time3,
321
+ **Type:** String,
322
+ **Units:** ,
323
+ **Required:** false,
324
+ **Model Dependent:** false
325
+
326
+ ### Start time of cooling setpoint adjustment for the fourth season (optional)
327
+ In HH:MM:SS format
328
+ **Name:** cooling_start_time4,
329
+ **Type:** String,
330
+ **Units:** ,
331
+ **Required:** false,
332
+ **Model Dependent:** false
333
+
334
+ ### End time of cooling setpoint adjustment for the fourth season (optional)
335
+ In HH:MM:SS format
336
+ **Name:** cooling_end_time4,
337
+ **Type:** String,
338
+ **Units:** ,
339
+ **Required:** false,
340
+ **Model Dependent:** false
341
+
342
+ ### Start time of cooling setpoint adjustment for the fifth season (optional)
343
+ In HH:MM:SS format
344
+ **Name:** cooling_start_time5,
345
+ **Type:** String,
130
346
  **Units:** ,
131
347
  **Required:** false,
132
348
  **Model Dependent:** false
133
349
 
134
- ### Alternate Peak and Take Periods
350
+ ### End time of cooling setpoint adjustment for the fifth season (optional)
351
+ In HH:MM:SS format
352
+ **Name:** cooling_end_time5,
353
+ **Type:** String,
354
+ **Units:** ,
355
+ **Required:** false,
356
+ **Model Dependent:** false
135
357
 
358
+ ### Use alternative default start and end time based on the state of the model from the Cambium load profile peak period?
359
+ This will overwrite the start and end time and date provided by the user
136
360
  **Name:** alt_periods,
137
361
  **Type:** Boolean,
138
362
  **Units:** ,
139
- **Required:** false,
363
+ **Required:** true,
140
364
  **Model Dependent:** false
141
365
 
142
366