openstudio-geb 0.6.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 (41) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -1
  3. data/Gemfile +1 -1
  4. data/lib/measures/AddElectricVehicleChargingLoad/README.md +16 -0
  5. data/lib/measures/AddElectricVehicleChargingLoad/measure.xml +64 -32
  6. data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/README.md +266 -42
  7. data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/measure.xml +330 -95
  8. data/lib/measures/GEB Metrics Report/README.md +41 -1
  9. data/lib/measures/GEB Metrics Report/measure.xml +84 -241
  10. data/lib/measures/GEB Metrics Report/resources/os_lib_reporting.rb +5 -5
  11. data/lib/measures/add_ceiling_fan/measure.xml +30 -30
  12. data/lib/measures/add_chilled_water_storage_tank/README.md +73 -33
  13. data/lib/measures/add_chilled_water_storage_tank/measure.rb +5 -0
  14. data/lib/measures/add_chilled_water_storage_tank/measure.xml +23 -23
  15. data/lib/measures/add_chilled_water_storage_tank/tests/370_medium_office_doas_fan_coil_acc_boiler_3A.osm +31800 -0
  16. data/lib/measures/add_chilled_water_storage_tank/tests/LargeOffice-90.1-2013-ASHRAE 169-2013-5A.osm +22036 -0
  17. data/lib/measures/add_exterior_blinds_and_control/measure.xml +28 -28
  18. data/lib/measures/add_fan_assist_night_ventilation_with_hybrid_control/measure.rb +5 -0
  19. data/lib/measures/add_fan_assist_night_ventilation_with_hybrid_control/measure.xml +20 -44
  20. data/lib/measures/add_heat_pump_water_heater/measure.rb +28 -28
  21. data/lib/measures/add_heat_pump_water_heater/measure.xml +30 -95
  22. data/lib/measures/add_interior_blinds_and_control/measure.xml +28 -28
  23. data/lib/measures/add_rooftop_pv_simple/measure.xml +24 -24
  24. data/lib/measures/apply_dynamic_coating_to_roof_wall/LICENSE.md +13 -1
  25. data/lib/measures/apply_dynamic_coating_to_roof_wall/measure.rb +5 -0
  26. data/lib/measures/apply_dynamic_coating_to_roof_wall/measure.xml +20 -14
  27. data/lib/measures/apply_dynamic_coating_to_roof_wall/tests/SFD_1story_UB_UA_ASHP2_HPWH.osm +13110 -0
  28. data/lib/measures/apply_dynamic_coating_to_roof_wall/tests/apply_dynamic_coating_to_roof_wall_test.rb +5 -0
  29. data/lib/measures/average_ventilation_for_peak_hours/measure.xml +20 -20
  30. data/lib/measures/enable_occupancy_driven_lighting/measure.xml +28 -28
  31. data/lib/measures/precooling/README.md +137 -17
  32. data/lib/measures/precooling/measure.xml +172 -44
  33. data/lib/measures/preheating/README.md +125 -21
  34. data/lib/measures/preheating/measure.xml +160 -50
  35. data/lib/measures/reduce_epd_by_percentage_for_peak_hours/README.md +125 -29
  36. data/lib/measures/reduce_epd_by_percentage_for_peak_hours/measure.xml +178 -70
  37. data/lib/measures/reduce_lpd_by_percentage_for_peak_hours/README.md +132 -28
  38. data/lib/measures/reduce_lpd_by_percentage_for_peak_hours/measure.xml +186 -69
  39. data/lib/openstudio/geb/version.rb +1 -1
  40. data/openstudio-geb.gemspec +4 -2
  41. metadata +37 -6
@@ -1,40 +1,81 @@
1
1
  <?xml version="1.0"?>
2
2
  <measure>
3
- <schema_version>3.0</schema_version>
4
- <error>wrong number of arguments (given 1, expected 0)</error>
3
+ <schema_version>3.1</schema_version>
5
4
  <name>geb_metrics_report</name>
6
5
  <uid>de3dd145-8762-4f1d-b4b5-a3b90c985c19</uid>
7
- <version_id>9a5d71fc-a377-4290-858b-9b47a4a2e6cc</version_id>
8
- <version_modified>20230719T172108Z</version_modified>
6
+ <version_id>2a013e83-786d-4f5e-af69-f5ac3cc0fd9f</version_id>
7
+ <version_modified>2025-06-30T21:09:48Z</version_modified>
9
8
  <xml_checksum>5EE3671C</xml_checksum>
10
9
  <class_name>GEBMetricsReport</class_name>
11
10
  <display_name>GEB Metrics Report</display_name>
12
11
  <description>This measure calculates GEB-related (mainly DF) metrics and reports them.</description>
13
- <modeler_description>GEB metrics compare between baseline and GEB measures. To enable the GEB metrics calculation, please make sure the output variable -Facility Total Electric Demand Power- is added to both baseline and retrofit models.</modeler_description>
12
+ <modeler_description>GEB metrics compare between baseline and GEB measures. To enable the GEB metrics calculation, please make sure the output variable -Facility Net Purchased Electricity Rate- is added to both baseline and retrofit models.</modeler_description>
14
13
  <arguments>
14
+ <argument>
15
+ <name>geb_metrics_section</name>
16
+ <display_name>GEB metrics</display_name>
17
+ <description>Choose whether or not to report geb_metrics_section</description>
18
+ <type>Boolean</type>
19
+ <required>true</required>
20
+ <model_dependent>false</model_dependent>
21
+ <default_value>true</default_value>
22
+ <choices>
23
+ <choice>
24
+ <value>true</value>
25
+ <display_name>true</display_name>
26
+ </choice>
27
+ <choice>
28
+ <value>false</value>
29
+ <display_name>false</display_name>
30
+ </choice>
31
+ </choices>
32
+ </argument>
15
33
  <argument>
16
34
  <name>event_date</name>
17
35
  <display_name>The event date for GEB metrics reporting purpose</display_name>
18
36
  <description>In MM-DD format</description>
19
37
  <type>String</type>
20
- <units></units>
21
38
  <required>true</required>
22
39
  <model_dependent>false</model_dependent>
23
- <default_value></default_value>
24
- <min_value></min_value>
25
- <max_value></max_value>
40
+ </argument>
41
+ <argument>
42
+ <name>shed_start</name>
43
+ <display_name>Enter Starting Time for Shed Period:</display_name>
44
+ <description>Use 24 hour format HH:MM:SS</description>
45
+ <type>String</type>
46
+ <required>false</required>
47
+ <model_dependent>false</model_dependent>
48
+ </argument>
49
+ <argument>
50
+ <name>shed_end</name>
51
+ <display_name>Enter End Time for Shed Period:</display_name>
52
+ <description>Use 24 hour format HH:MM:SS</description>
53
+ <type>String</type>
54
+ <required>false</required>
55
+ <model_dependent>false</model_dependent>
56
+ </argument>
57
+ <argument>
58
+ <name>take_start</name>
59
+ <display_name>Enter Starting Time for Take Period:</display_name>
60
+ <description>Use 24 hour format HH:MM:SS</description>
61
+ <type>String</type>
62
+ <required>false</required>
63
+ <model_dependent>false</model_dependent>
64
+ </argument>
65
+ <argument>
66
+ <name>take_end</name>
67
+ <display_name>Enter End Time for Take Period:</display_name>
68
+ <description>Use 24 hour format HH:MM:SS</description>
69
+ <type>String</type>
70
+ <required>false</required>
71
+ <model_dependent>false</model_dependent>
26
72
  </argument>
27
73
  <argument>
28
74
  <name>baseline_run_output_path</name>
29
75
  <display_name>Output path</display_name>
30
- <description></description>
31
76
  <type>Path</type>
32
- <units></units>
33
77
  <required>true</required>
34
78
  <model_dependent>false</model_dependent>
35
- <default_value></default_value>
36
- <min_value></min_value>
37
- <max_value></max_value>
38
79
  </argument>
39
80
  </arguments>
40
81
  <outputs />
@@ -65,24 +106,6 @@
65
106
  </attribute>
66
107
  </attributes>
67
108
  <files>
68
- <file>
69
- <filename>README.md.erb</filename>
70
- <filetype>erb</filetype>
71
- <usage_type>readmeerb</usage_type>
72
- <checksum>703C9964</checksum>
73
- </file>
74
- <file>
75
- <filename>.gitkeep</filename>
76
- <filetype>gitkeep</filetype>
77
- <usage_type>doc</usage_type>
78
- <checksum>00000000</checksum>
79
- </file>
80
- <file>
81
- <filename>small_office_simple_w_CO2_daylighting.osm</filename>
82
- <filetype>osm</filetype>
83
- <usage_type>test</usage_type>
84
- <checksum>106D8627</checksum>
85
- </file>
86
109
  <file>
87
110
  <filename>LICENSE.md</filename>
88
111
  <filetype>md</filetype>
@@ -90,22 +113,22 @@
90
113
  <checksum>BFFB1AA6</checksum>
91
114
  </file>
92
115
  <file>
93
- <filename>os_lib_helper_methods.rb</filename>
94
- <filetype>rb</filetype>
95
- <usage_type>resource</usage_type>
96
- <checksum>FEACB9A1</checksum>
116
+ <filename>README.md</filename>
117
+ <filetype>md</filetype>
118
+ <usage_type>readme</usage_type>
119
+ <checksum>212E96A4</checksum>
97
120
  </file>
98
121
  <file>
99
- <filename>report.html.erb</filename>
122
+ <filename>README.md.erb</filename>
100
123
  <filetype>erb</filetype>
101
- <usage_type>resource</usage_type>
102
- <checksum>FFA4B403</checksum>
124
+ <usage_type>readmeerb</usage_type>
125
+ <checksum>703C9964</checksum>
103
126
  </file>
104
127
  <file>
105
- <filename>os_lib_reporting.rb</filename>
106
- <filetype>rb</filetype>
107
- <usage_type>resource</usage_type>
108
- <checksum>98131F05</checksum>
128
+ <filename>.gitkeep</filename>
129
+ <filetype>gitkeep</filetype>
130
+ <usage_type>doc</usage_type>
131
+ <checksum>00000000</checksum>
109
132
  </file>
110
133
  <file>
111
134
  <version>
@@ -119,202 +142,28 @@
119
142
  <checksum>B2A084B4</checksum>
120
143
  </file>
121
144
  <file>
122
- <filename>CZ06RV2.epw</filename>
123
- <filetype>epw</filetype>
124
- <usage_type>test</usage_type>
125
- <checksum>52282D70</checksum>
126
- </file>
127
- <file>
128
- <filename>baseline/out.osw</filename>
129
- <filetype>osw</filetype>
130
- <usage_type>test</usage_type>
131
- <checksum>81394943</checksum>
132
- </file>
133
- <file>
134
- <filename>baseline/baseline.osm</filename>
135
- <filetype>osm</filetype>
136
- <usage_type>test</usage_type>
137
- <checksum>1DAFFE27</checksum>
138
- </file>
139
- <file>
140
- <filename>baseline/baseline.osw</filename>
141
- <filetype>osw</filetype>
142
- <usage_type>test</usage_type>
143
- <checksum>1DA31EB3</checksum>
144
- </file>
145
- <file>
146
- <filename>baseline/run/in.osm</filename>
147
- <filetype>osm</filetype>
148
- <usage_type>test</usage_type>
149
- <checksum>E9F1D709</checksum>
150
- </file>
151
- <file>
152
- <filename>baseline/run/eplusout.shd</filename>
153
- <filetype>shd</filetype>
154
- <usage_type>test</usage_type>
155
- <checksum>E865DCFA</checksum>
156
- </file>
157
- <file>
158
- <filename>baseline/run/eplustbl.htm</filename>
159
- <filetype>htm</filetype>
160
- <usage_type>test</usage_type>
161
- <checksum>E530BAF4</checksum>
162
- </file>
163
- <file>
164
- <filename>baseline/run/stdout-expandobject</filename>
165
- <filetype></filetype>
166
- <usage_type>test</usage_type>
167
- <checksum>1A38BEA7</checksum>
168
- </file>
169
- <file>
170
- <filename>baseline/run/eplusout.mdd</filename>
171
- <filetype>mdd</filetype>
172
- <usage_type>test</usage_type>
173
- <checksum>D6E3BBDD</checksum>
174
- </file>
175
- <file>
176
- <filename>baseline/run/eplusout.audit</filename>
177
- <filetype>audit</filetype>
178
- <usage_type>test</usage_type>
179
- <checksum>4634D8ED</checksum>
180
- </file>
181
- <file>
182
- <filename>baseline/run/run.log</filename>
183
- <filetype>log</filetype>
184
- <usage_type>test</usage_type>
185
- <checksum>00000000</checksum>
186
- </file>
187
- <file>
188
- <filename>baseline/run/eplusout.rdd</filename>
189
- <filetype>rdd</filetype>
190
- <usage_type>test</usage_type>
191
- <checksum>125FD099</checksum>
192
- </file>
193
- <file>
194
- <filename>baseline/run/eplusout.eio</filename>
195
- <filetype>eio</filetype>
196
- <usage_type>test</usage_type>
197
- <checksum>BAA66A35</checksum>
198
- </file>
199
- <file>
200
- <filename>baseline/run/eplusssz.csv</filename>
201
- <filetype>csv</filetype>
202
- <usage_type>test</usage_type>
203
- <checksum>57B7E6F9</checksum>
204
- </file>
205
- <file>
206
- <filename>baseline/run/results.json</filename>
207
- <filetype>json</filetype>
208
- <usage_type>test</usage_type>
209
- <checksum>73BEBBA8</checksum>
210
- </file>
211
- <file>
212
- <filename>baseline/run/finished.job</filename>
213
- <filetype>job</filetype>
214
- <usage_type>test</usage_type>
215
- <checksum>1E4958FD</checksum>
216
- </file>
217
- <file>
218
- <filename>baseline/run/eplusout.err</filename>
219
- <filetype>err</filetype>
220
- <usage_type>test</usage_type>
221
- <checksum>5D0C3CC0</checksum>
222
- </file>
223
- <file>
224
- <filename>baseline/run/data_point.zip</filename>
225
- <filetype>zip</filetype>
226
- <usage_type>test</usage_type>
227
- <checksum>D84E1C83</checksum>
228
- </file>
229
- <file>
230
- <filename>baseline/run/stdout-energyplus</filename>
231
- <filetype></filetype>
232
- <usage_type>test</usage_type>
233
- <checksum>104DDC36</checksum>
234
- </file>
235
- <file>
236
- <filename>baseline/run/eplusout.eso</filename>
237
- <filetype>eso</filetype>
238
- <usage_type>test</usage_type>
239
- <checksum>A0791896</checksum>
240
- </file>
241
- <file>
242
- <filename>baseline/run/in.idf</filename>
243
- <filetype>idf</filetype>
244
- <usage_type>test</usage_type>
245
- <checksum>A0ACFC21</checksum>
246
- </file>
247
- <file>
248
- <filename>baseline/run/eplusout.end</filename>
249
- <filetype>end</filetype>
250
- <usage_type>test</usage_type>
251
- <checksum>7AE603B1</checksum>
252
- </file>
253
- <file>
254
- <filename>baseline/run/eplusout.sql</filename>
255
- <filetype>sql</filetype>
256
- <usage_type>test</usage_type>
257
- <checksum>A436973E</checksum>
258
- </file>
259
- <file>
260
- <filename>baseline/run/epluszsz.csv</filename>
261
- <filetype>csv</filetype>
262
- <usage_type>test</usage_type>
263
- <checksum>EECD4641</checksum>
264
- </file>
265
- <file>
266
- <filename>baseline/run/data_point_out.json</filename>
267
- <filetype>json</filetype>
268
- <usage_type>test</usage_type>
269
- <checksum>73BEBBA8</checksum>
270
- </file>
271
- <file>
272
- <filename>baseline/run/started.job</filename>
273
- <filetype>job</filetype>
274
- <usage_type>test</usage_type>
275
- <checksum>92F635F9</checksum>
276
- </file>
277
- <file>
278
- <filename>baseline/run/sqlite.err</filename>
279
- <filetype>err</filetype>
280
- <usage_type>test</usage_type>
281
- <checksum>D834FBC1</checksum>
282
- </file>
283
- <file>
284
- <filename>baseline/run/objectives.json</filename>
285
- <filetype>json</filetype>
286
- <usage_type>test</usage_type>
287
- <checksum>73BEBBA8</checksum>
288
- </file>
289
- <file>
290
- <filename>baseline/run/measure_attributes.json</filename>
291
- <filetype>json</filetype>
292
- <usage_type>test</usage_type>
293
- <checksum>73BEBBA8</checksum>
294
- </file>
295
- <file>
296
- <filename>baseline/run/eplusout.bnd</filename>
297
- <filetype>bnd</filetype>
298
- <usage_type>test</usage_type>
299
- <checksum>2B77D071</checksum>
145
+ <filename>os_lib_helper_methods.rb</filename>
146
+ <filetype>rb</filetype>
147
+ <usage_type>resource</usage_type>
148
+ <checksum>FEACB9A1</checksum>
300
149
  </file>
301
150
  <file>
302
- <filename>baseline/run/eplusout.mtd</filename>
303
- <filetype>mtd</filetype>
304
- <usage_type>test</usage_type>
305
- <checksum>F82856DF</checksum>
151
+ <filename>os_lib_reporting.rb</filename>
152
+ <filetype>rb</filetype>
153
+ <usage_type>resource</usage_type>
154
+ <checksum>1103A285</checksum>
306
155
  </file>
307
156
  <file>
308
- <filename>baseline/run/pre-preprocess.idf</filename>
309
- <filetype>idf</filetype>
310
- <usage_type>test</usage_type>
311
- <checksum>CEF1EA7A</checksum>
157
+ <filename>report.html.erb</filename>
158
+ <filetype>erb</filetype>
159
+ <usage_type>resource</usage_type>
160
+ <checksum>FFA4B403</checksum>
312
161
  </file>
313
162
  <file>
314
- <filename>baseline/reports/eplustbl.html</filename>
315
- <filetype>html</filetype>
163
+ <filename>CZ06RV2.epw</filename>
164
+ <filetype>epw</filetype>
316
165
  <usage_type>test</usage_type>
317
- <checksum>A3B928F4</checksum>
166
+ <checksum>52282D70</checksum>
318
167
  </file>
319
168
  <file>
320
169
  <filename>geb_metrics_report_test.rb</filename>
@@ -323,16 +172,10 @@
323
172
  <checksum>7D0DCE15</checksum>
324
173
  </file>
325
174
  <file>
326
- <filename>README.md</filename>
327
- <filetype>md</filetype>
328
- <usage_type>readme</usage_type>
329
- <checksum>0B68E96D</checksum>
330
- </file>
331
- <file>
332
- <filename>occupant_centric_kpi_report_test.rb</filename>
333
- <filetype>rb</filetype>
175
+ <filename>small_office_simple_w_CO2_daylighting.osm</filename>
176
+ <filetype>osm</filetype>
334
177
  <usage_type>test</usage_type>
335
- <checksum>3D6AD315</checksum>
178
+ <checksum>106D8627</checksum>
336
179
  </file>
337
180
  </files>
338
181
  </measure>
@@ -1,8 +1,8 @@
1
- # *******************************************************************************
2
- # OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
3
- # See also https://openstudio.net/license
4
- # *******************************************************************************
5
-
1
+ # *******************************************************************************
2
+ # OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
3
+ # See also https://openstudio.net/license
4
+ # *******************************************************************************
5
+
6
6
  require 'json'
7
7
  require 'openstudio-standards'
8
8
  require 'yaml'
@@ -1,10 +1,10 @@
1
1
  <?xml version="1.0"?>
2
2
  <measure>
3
- <schema_version>3.0</schema_version>
3
+ <schema_version>3.1</schema_version>
4
4
  <name>add_ceiling_fan</name>
5
5
  <uid>a025ba5b-fb89-472e-a9e3-9edc14a631b0</uid>
6
- <version_id>96086fff-d2ed-415a-a9fb-91abc68e766e</version_id>
7
- <version_modified>20230719T172112Z</version_modified>
6
+ <version_id>58836a0e-2866-41b4-8a14-bd46f07a5833</version_id>
7
+ <version_modified>2025-06-30T21:09:49Z</version_modified>
8
8
  <xml_checksum>FD8E710D</xml_checksum>
9
9
  <class_name>AddCeilingFan</class_name>
10
10
  <display_name>Add Ceiling Fan</display_name>
@@ -163,6 +163,18 @@
163
163
  </attribute>
164
164
  </attributes>
165
165
  <files>
166
+ <file>
167
+ <filename>LICENSE.md</filename>
168
+ <filetype>md</filetype>
169
+ <usage_type>license</usage_type>
170
+ <checksum>BFFB1AA6</checksum>
171
+ </file>
172
+ <file>
173
+ <filename>README.md</filename>
174
+ <filetype>md</filetype>
175
+ <usage_type>readme</usage_type>
176
+ <checksum>251293B0</checksum>
177
+ </file>
166
178
  <file>
167
179
  <filename>README.md.erb</filename>
168
180
  <filetype>erb</filetype>
@@ -175,18 +187,23 @@
175
187
  <usage_type>doc</usage_type>
176
188
  <checksum>00000000</checksum>
177
189
  </file>
190
+ <file>
191
+ <version>
192
+ <software_program>OpenStudio</software_program>
193
+ <identifier>3.4.0</identifier>
194
+ <min_compatible>3.4.0</min_compatible>
195
+ </version>
196
+ <filename>measure.rb</filename>
197
+ <filetype>rb</filetype>
198
+ <usage_type>script</usage_type>
199
+ <checksum>B6CB770B</checksum>
200
+ </file>
178
201
  <file>
179
202
  <filename>CZ06RV2.epw</filename>
180
203
  <filetype>epw</filetype>
181
204
  <usage_type>test</usage_type>
182
205
  <checksum>52282D70</checksum>
183
206
  </file>
184
- <file>
185
- <filename>SFD_1story_UB_UA_ASHP2_HPWH.osm</filename>
186
- <filetype>osm</filetype>
187
- <usage_type>test</usage_type>
188
- <checksum>F0332415</checksum>
189
- </file>
190
207
  <file>
191
208
  <filename>MediumOffice-90.1-2010-ASHRAE 169-2013-5A.osm</filename>
192
209
  <filetype>osm</filetype>
@@ -194,27 +211,10 @@
194
211
  <checksum>A364A953</checksum>
195
212
  </file>
196
213
  <file>
197
- <filename>README.md</filename>
198
- <filetype>md</filetype>
199
- <usage_type>readme</usage_type>
200
- <checksum>251293B0</checksum>
201
- </file>
202
- <file>
203
- <filename>LICENSE.md</filename>
204
- <filetype>md</filetype>
205
- <usage_type>license</usage_type>
206
- <checksum>BFFB1AA6</checksum>
207
- </file>
208
- <file>
209
- <version>
210
- <software_program>OpenStudio</software_program>
211
- <identifier>3.4.0</identifier>
212
- <min_compatible>3.4.0</min_compatible>
213
- </version>
214
- <filename>measure.rb</filename>
215
- <filetype>rb</filetype>
216
- <usage_type>script</usage_type>
217
- <checksum>A724F7C4</checksum>
214
+ <filename>SFD_1story_UB_UA_ASHP2_HPWH.osm</filename>
215
+ <filetype>osm</filetype>
216
+ <usage_type>test</usage_type>
217
+ <checksum>F0332415</checksum>
218
218
  </file>
219
219
  <file>
220
220
  <filename>add_ceiling_fan_test.rb</filename>