openstudio-load-flexibility-measures 0.2.1 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +36 -36
  3. data/.rubocop.yml +6 -9
  4. data/CHANGELOG.html +75 -75
  5. data/CHANGELOG.md +59 -37
  6. data/Gemfile +31 -7
  7. data/Jenkinsfile +11 -0
  8. data/README.md +53 -42
  9. data/Rakefile +15 -15
  10. data/doc_templates/LICENSE.md +26 -26
  11. data/doc_templates/README.md.erb +41 -41
  12. data/doc_templates/copyright_erb.txt +35 -35
  13. data/doc_templates/copyright_js.txt +3 -3
  14. data/doc_templates/copyright_ruby.txt +33 -33
  15. data/lib/measures/add_central_ice_storage/LICENSE.md +26 -26
  16. data/lib/measures/add_central_ice_storage/README.md +264 -264
  17. data/lib/measures/add_central_ice_storage/README.md.erb +41 -41
  18. data/lib/measures/add_central_ice_storage/measure.rb +1325 -1324
  19. data/lib/measures/add_central_ice_storage/measure.xml +503 -503
  20. data/lib/measures/add_central_ice_storage/resources/OsLib_Schedules.rb +171 -173
  21. data/lib/measures/add_central_ice_storage/tests/add_central_ice_storage_test.rb +203 -203
  22. data/lib/measures/add_central_ice_storage/tests/ice_test_model.osm +21523 -21523
  23. data/lib/measures/add_hpwh/LICENSE.md +26 -26
  24. data/lib/measures/add_hpwh/README.md +186 -186
  25. data/lib/measures/add_hpwh/README.md.erb +41 -41
  26. data/lib/measures/add_hpwh/docs/Flexible Domestic Hot Water Implementation Guide.pdf +0 -0
  27. data/lib/measures/add_hpwh/measure.rb +663 -647
  28. data/lib/measures/add_hpwh/measure.xml +402 -397
  29. data/lib/measures/add_hpwh/tests/SmallHotel-2A.osm +42893 -42893
  30. data/lib/measures/add_hpwh/tests/{add_hphw_test.rb → add_hpwh_test.rb} +137 -98
  31. data/lib/measures/add_packaged_ice_storage/LICENSE.md +26 -26
  32. data/lib/measures/add_packaged_ice_storage/README.html +185 -185
  33. data/lib/measures/add_packaged_ice_storage/README.md +189 -189
  34. data/lib/measures/add_packaged_ice_storage/measure.rb +694 -691
  35. data/lib/measures/add_packaged_ice_storage/measure.xml +245 -245
  36. data/lib/measures/add_packaged_ice_storage/resources/TESCurves.idf +1059 -1059
  37. data/lib/measures/add_packaged_ice_storage/tests/MeasureTest.osm +9507 -9507
  38. data/lib/measures/add_packaged_ice_storage/tests/add_packaged_ice_storage_test.rb +96 -96
  39. data/lib/openstudio/load_flexibility_measures/version.rb +40 -40
  40. data/lib/openstudio/load_flexibility_measures.rb +50 -50
  41. data/openstudio-load-flexibility-measures.gemspec +33 -32
  42. metadata +27 -27
@@ -1,245 +1,245 @@
1
- <?xml version="1.0"?>
2
- <measure>
3
- <schema_version>3.0</schema_version>
4
- <name>add_packaged_ice_storage</name>
5
- <uid>2aa8c128-53b9-49fd-9aaf-9253a1f05936</uid>
6
- <version_id>1a0ab79e-1825-4418-a4ad-aec2194d4707</version_id>
7
- <version_modified>20201208T224029Z</version_modified>
8
- <xml_checksum>2617824F</xml_checksum>
9
- <class_name>AddPackagedIceStorage</class_name>
10
- <display_name>Add Packaged Ice Storage</display_name>
11
- <description>This measure removes the cooling coils in the model and replaces them with packaged air conditioning units with integrated ice storage.</description>
12
- <modeler_description>This measure applies to packaged single zone air conditioning systems or packaged variable air volume systems that were originally modeled with CoilSystem:Cooling:DX or AirLoopHVAC:UnitarySystem container objects. It adds a Coil:Cooling:DX:SingleSpeed:ThermalStorage coil object to each user-selected thermal zone and deletes the existing cooling coil.
13
-
14
- Users inputs are accepted for cooling coil size, ice storage size, system control method, modes of operation, and operating schedule.
15
-
16
- The measure requires schedule objects and performance curves from an included resource file TESCurves.idf. Output variables of typical interest are included as well.</modeler_description>
17
- <arguments>
18
- <argument>
19
- <name>ice_cap</name>
20
- <display_name>Input the ice storage capacity [ton-hours]</display_name>
21
- <description>To specify by coil, in alphabetical order, enter values for each separated by comma.</description>
22
- <type>String</type>
23
- <required>true</required>
24
- <model_dependent>false</model_dependent>
25
- <default_value>AutoSize</default_value>
26
- </argument>
27
- <argument>
28
- <name>size_mult</name>
29
- <display_name>Enter a sizing multiplier to manually adjust the autosize results for ice tank capacities</display_name>
30
- <type>String</type>
31
- <required>false</required>
32
- <model_dependent>false</model_dependent>
33
- <default_value>1.0</default_value>
34
- </argument>
35
- <argument>
36
- <name>ctl</name>
37
- <display_name>Select ice storage control method</display_name>
38
- <type>Choice</type>
39
- <required>true</required>
40
- <model_dependent>false</model_dependent>
41
- <default_value>EMSControlled</default_value>
42
- <choices>
43
- <choice>
44
- <value>ScheduledModes</value>
45
- <display_name>ScheduledModes</display_name>
46
- </choice>
47
- <choice>
48
- <value>EMSControlled</value>
49
- <display_name>EMSControlled</display_name>
50
- </choice>
51
- </choices>
52
- </argument>
53
- <argument>
54
- <name>sched</name>
55
- <display_name>Select the operating mode schedule for the new TES coils</display_name>
56
- <description>Use the fields below to set a simple daily ice charge/discharge schedule. Or, select from pre-defined options.</description>
57
- <type>Choice</type>
58
- <required>true</required>
59
- <model_dependent>false</model_dependent>
60
- <default_value>Simple User Sched</default_value>
61
- <choices>
62
- <choice>
63
- <value>Simple User Sched</value>
64
- <display_name>Simple User Sched</display_name>
65
- </choice>
66
- <choice>
67
- <value>TES Sched 1: TES Off</value>
68
- <display_name>TES Sched 1: TES Off</display_name>
69
- </choice>
70
- <choice>
71
- <value>TES Sched 2: 1-5 Peak</value>
72
- <display_name>TES Sched 2: 1-5 Peak</display_name>
73
- </choice>
74
- <choice>
75
- <value>TES Sched 3: 3-8 Peak</value>
76
- <display_name>TES Sched 3: 3-8 Peak</display_name>
77
- </choice>
78
- <choice>
79
- <value>TES Sched 4: GSS-T</value>
80
- <display_name>TES Sched 4: GSS-T</display_name>
81
- </choice>
82
- </choices>
83
- </argument>
84
- <argument>
85
- <name>wknd</name>
86
- <display_name>Run TES on the weekends</display_name>
87
- <description>Select if building is occupied on weekends</description>
88
- <type>Boolean</type>
89
- <required>false</required>
90
- <model_dependent>false</model_dependent>
91
- <default_value>true</default_value>
92
- <choices>
93
- <choice>
94
- <value>true</value>
95
- <display_name>true</display_name>
96
- </choice>
97
- <choice>
98
- <value>false</value>
99
- <display_name>false</display_name>
100
- </choice>
101
- </choices>
102
- </argument>
103
- <argument>
104
- <name>season</name>
105
- <display_name>Select season during which the ice cooling may be used</display_name>
106
- <description>Use MM/DD-MM/DD format</description>
107
- <type>String</type>
108
- <required>false</required>
109
- <model_dependent>false</model_dependent>
110
- <default_value>01/01-12/31</default_value>
111
- </argument>
112
- <argument>
113
- <name>charge_start</name>
114
- <display_name>Input start time for ice charge (hr:min)</display_name>
115
- <description>Use 24 hour format</description>
116
- <type>String</type>
117
- <required>false</required>
118
- <model_dependent>false</model_dependent>
119
- <default_value>22:00</default_value>
120
- </argument>
121
- <argument>
122
- <name>charge_end</name>
123
- <display_name>Input end time for ice charge (hr:min)</display_name>
124
- <description>Use 24 hour format</description>
125
- <type>String</type>
126
- <required>false</required>
127
- <model_dependent>false</model_dependent>
128
- <default_value>07:00</default_value>
129
- </argument>
130
- <argument>
131
- <name>discharge_start</name>
132
- <display_name>Input start time for ice discharge (hr:min)</display_name>
133
- <description>Use 24hour format.
134
- If 'AutoSize' is selected for ice capacity, these inputs set an ice capacity sizing factor. Otherwise, these only affect discharging schedule.</description>
135
- <type>String</type>
136
- <required>false</required>
137
- <model_dependent>false</model_dependent>
138
- <default_value>12:00</default_value>
139
- </argument>
140
- <argument>
141
- <name>discharge_end</name>
142
- <display_name>Input target end time for ice discharge (hr:min)</display_name>
143
- <description>Use 24 hour format</description>
144
- <type>String</type>
145
- <required>false</required>
146
- <model_dependent>false</model_dependent>
147
- <default_value>18:00</default_value>
148
- </argument>
149
- </arguments>
150
- <outputs />
151
- <provenances />
152
- <tags>
153
- <tag>HVAC.Cooling</tag>
154
- </tags>
155
- <attributes>
156
- <attribute>
157
- <name>Intended Software Tool</name>
158
- <value>OpenStudio Application</value>
159
- <datatype>string</datatype>
160
- </attribute>
161
- <attribute>
162
- <name>Intended Software Tool</name>
163
- <value>Parametric Analysis Tool</value>
164
- <datatype>string</datatype>
165
- </attribute>
166
- <attribute>
167
- <name>Intended Use Case</name>
168
- <value>Model Articulation</value>
169
- <datatype>string</datatype>
170
- </attribute>
171
- <attribute>
172
- <name>Measure Type</name>
173
- <value>EnergyPlusMeasure</value>
174
- <datatype>string</datatype>
175
- </attribute>
176
- <attribute>
177
- <name>Intended Software Tool</name>
178
- <value>OpenStudio Application</value>
179
- <datatype>string</datatype>
180
- </attribute>
181
- <attribute>
182
- <name>Intended Software Tool</name>
183
- <value>Parametric Analysis Tool</value>
184
- <datatype>string</datatype>
185
- </attribute>
186
- <attribute>
187
- <name>Intended Use Case</name>
188
- <value>Model Articulation</value>
189
- <datatype>string</datatype>
190
- </attribute>
191
- <attribute>
192
- <name>Intended Use Case</name>
193
- <value>New Construction EE</value>
194
- <datatype>string</datatype>
195
- </attribute>
196
- <attribute>
197
- <name>Intended Use Case</name>
198
- <value>Retrofit EE</value>
199
- <datatype>string</datatype>
200
- </attribute>
201
- </attributes>
202
- <files>
203
- <file>
204
- <filename>TESCurves.idf</filename>
205
- <filetype>idf</filetype>
206
- <usage_type>resource</usage_type>
207
- <checksum>E919566C</checksum>
208
- </file>
209
- <file>
210
- <filename>MeasureTest.osm</filename>
211
- <filetype>osm</filetype>
212
- <usage_type>test</usage_type>
213
- <checksum>DC0DCC4B</checksum>
214
- </file>
215
- <file>
216
- <filename>LICENSE.md</filename>
217
- <filetype>md</filetype>
218
- <usage_type>license</usage_type>
219
- <checksum>E0468DD6</checksum>
220
- </file>
221
- <file>
222
- <filename>add_packaged_ice_storage_test.rb</filename>
223
- <filetype>rb</filetype>
224
- <usage_type>test</usage_type>
225
- <checksum>2D918464</checksum>
226
- </file>
227
- <file>
228
- <filename>README.md</filename>
229
- <filetype>md</filetype>
230
- <usage_type>readme</usage_type>
231
- <checksum>A67F3738</checksum>
232
- </file>
233
- <file>
234
- <version>
235
- <software_program>OpenStudio</software_program>
236
- <identifier>3.0.0</identifier>
237
- <min_compatible>3.0.0</min_compatible>
238
- </version>
239
- <filename>measure.rb</filename>
240
- <filetype>rb</filetype>
241
- <usage_type>script</usage_type>
242
- <checksum>749A70A0</checksum>
243
- </file>
244
- </files>
245
- </measure>
1
+ <?xml version="1.0"?>
2
+ <measure>
3
+ <schema_version>3.0</schema_version>
4
+ <name>add_packaged_ice_storage</name>
5
+ <uid>2aa8c128-53b9-49fd-9aaf-9253a1f05936</uid>
6
+ <version_id>e2b362ea-1e2a-44b0-8f2b-add4d320b86d</version_id>
7
+ <version_modified>20211110T211235Z</version_modified>
8
+ <xml_checksum>2617824F</xml_checksum>
9
+ <class_name>AddPackagedIceStorage</class_name>
10
+ <display_name>Add Packaged Ice Storage</display_name>
11
+ <description>This measure removes the cooling coils in the model and replaces them with packaged air conditioning units with integrated ice storage.</description>
12
+ <modeler_description>This measure applies to packaged single zone air conditioning systems or packaged variable air volume systems that were originally modeled with CoilSystem:Cooling:DX or AirLoopHVAC:UnitarySystem container objects. It adds a Coil:Cooling:DX:SingleSpeed:ThermalStorage coil object to each user-selected thermal zone and deletes the existing cooling coil.
13
+
14
+ Users inputs are accepted for cooling coil size, ice storage size, system control method, modes of operation, and operating schedule.
15
+
16
+ The measure requires schedule objects and performance curves from an included resource file TESCurves.idf. Output variables of typical interest are included as well.</modeler_description>
17
+ <arguments>
18
+ <argument>
19
+ <name>ice_cap</name>
20
+ <display_name>Input the ice storage capacity [ton-hours]</display_name>
21
+ <description>To specify by coil, in alphabetical order, enter values for each separated by comma.</description>
22
+ <type>String</type>
23
+ <required>true</required>
24
+ <model_dependent>false</model_dependent>
25
+ <default_value>AutoSize</default_value>
26
+ </argument>
27
+ <argument>
28
+ <name>size_mult</name>
29
+ <display_name>Enter a sizing multiplier to manually adjust the autosize results for ice tank capacities</display_name>
30
+ <type>String</type>
31
+ <required>false</required>
32
+ <model_dependent>false</model_dependent>
33
+ <default_value>1.0</default_value>
34
+ </argument>
35
+ <argument>
36
+ <name>ctl</name>
37
+ <display_name>Select ice storage control method</display_name>
38
+ <type>Choice</type>
39
+ <required>true</required>
40
+ <model_dependent>false</model_dependent>
41
+ <default_value>EMSControlled</default_value>
42
+ <choices>
43
+ <choice>
44
+ <value>ScheduledModes</value>
45
+ <display_name>ScheduledModes</display_name>
46
+ </choice>
47
+ <choice>
48
+ <value>EMSControlled</value>
49
+ <display_name>EMSControlled</display_name>
50
+ </choice>
51
+ </choices>
52
+ </argument>
53
+ <argument>
54
+ <name>sched</name>
55
+ <display_name>Select the operating mode schedule for the new TES coils</display_name>
56
+ <description>Use the fields below to set a simple daily ice charge/discharge schedule. Or, select from pre-defined options.</description>
57
+ <type>Choice</type>
58
+ <required>true</required>
59
+ <model_dependent>false</model_dependent>
60
+ <default_value>Simple User Sched</default_value>
61
+ <choices>
62
+ <choice>
63
+ <value>Simple User Sched</value>
64
+ <display_name>Simple User Sched</display_name>
65
+ </choice>
66
+ <choice>
67
+ <value>TES Sched 1: TES Off</value>
68
+ <display_name>TES Sched 1: TES Off</display_name>
69
+ </choice>
70
+ <choice>
71
+ <value>TES Sched 2: 1-5 Peak</value>
72
+ <display_name>TES Sched 2: 1-5 Peak</display_name>
73
+ </choice>
74
+ <choice>
75
+ <value>TES Sched 3: 3-8 Peak</value>
76
+ <display_name>TES Sched 3: 3-8 Peak</display_name>
77
+ </choice>
78
+ <choice>
79
+ <value>TES Sched 4: GSS-T</value>
80
+ <display_name>TES Sched 4: GSS-T</display_name>
81
+ </choice>
82
+ </choices>
83
+ </argument>
84
+ <argument>
85
+ <name>wknd</name>
86
+ <display_name>Run TES on the weekends</display_name>
87
+ <description>Select if building is occupied on weekends</description>
88
+ <type>Boolean</type>
89
+ <required>false</required>
90
+ <model_dependent>false</model_dependent>
91
+ <default_value>true</default_value>
92
+ <choices>
93
+ <choice>
94
+ <value>true</value>
95
+ <display_name>true</display_name>
96
+ </choice>
97
+ <choice>
98
+ <value>false</value>
99
+ <display_name>false</display_name>
100
+ </choice>
101
+ </choices>
102
+ </argument>
103
+ <argument>
104
+ <name>season</name>
105
+ <display_name>Select season during which the ice cooling may be used</display_name>
106
+ <description>Use MM/DD-MM/DD format</description>
107
+ <type>String</type>
108
+ <required>false</required>
109
+ <model_dependent>false</model_dependent>
110
+ <default_value>01/01-12/31</default_value>
111
+ </argument>
112
+ <argument>
113
+ <name>charge_start</name>
114
+ <display_name>Input start time for ice charge (hr:min)</display_name>
115
+ <description>Use 24 hour format</description>
116
+ <type>String</type>
117
+ <required>false</required>
118
+ <model_dependent>false</model_dependent>
119
+ <default_value>22:00</default_value>
120
+ </argument>
121
+ <argument>
122
+ <name>charge_end</name>
123
+ <display_name>Input end time for ice charge (hr:min)</display_name>
124
+ <description>Use 24 hour format</description>
125
+ <type>String</type>
126
+ <required>false</required>
127
+ <model_dependent>false</model_dependent>
128
+ <default_value>07:00</default_value>
129
+ </argument>
130
+ <argument>
131
+ <name>discharge_start</name>
132
+ <display_name>Input start time for ice discharge (hr:min)</display_name>
133
+ <description>Use 24hour format.
134
+ If 'AutoSize' is selected for ice capacity, these inputs set an ice capacity sizing factor. Otherwise, these only affect discharging schedule.</description>
135
+ <type>String</type>
136
+ <required>false</required>
137
+ <model_dependent>false</model_dependent>
138
+ <default_value>12:00</default_value>
139
+ </argument>
140
+ <argument>
141
+ <name>discharge_end</name>
142
+ <display_name>Input target end time for ice discharge (hr:min)</display_name>
143
+ <description>Use 24 hour format</description>
144
+ <type>String</type>
145
+ <required>false</required>
146
+ <model_dependent>false</model_dependent>
147
+ <default_value>18:00</default_value>
148
+ </argument>
149
+ </arguments>
150
+ <outputs />
151
+ <provenances />
152
+ <tags>
153
+ <tag>HVAC.Cooling</tag>
154
+ </tags>
155
+ <attributes>
156
+ <attribute>
157
+ <name>Intended Software Tool</name>
158
+ <value>OpenStudio Application</value>
159
+ <datatype>string</datatype>
160
+ </attribute>
161
+ <attribute>
162
+ <name>Intended Software Tool</name>
163
+ <value>Parametric Analysis Tool</value>
164
+ <datatype>string</datatype>
165
+ </attribute>
166
+ <attribute>
167
+ <name>Intended Use Case</name>
168
+ <value>Model Articulation</value>
169
+ <datatype>string</datatype>
170
+ </attribute>
171
+ <attribute>
172
+ <name>Measure Type</name>
173
+ <value>EnergyPlusMeasure</value>
174
+ <datatype>string</datatype>
175
+ </attribute>
176
+ <attribute>
177
+ <name>Intended Software Tool</name>
178
+ <value>OpenStudio Application</value>
179
+ <datatype>string</datatype>
180
+ </attribute>
181
+ <attribute>
182
+ <name>Intended Software Tool</name>
183
+ <value>Parametric Analysis Tool</value>
184
+ <datatype>string</datatype>
185
+ </attribute>
186
+ <attribute>
187
+ <name>Intended Use Case</name>
188
+ <value>Model Articulation</value>
189
+ <datatype>string</datatype>
190
+ </attribute>
191
+ <attribute>
192
+ <name>Intended Use Case</name>
193
+ <value>New Construction EE</value>
194
+ <datatype>string</datatype>
195
+ </attribute>
196
+ <attribute>
197
+ <name>Intended Use Case</name>
198
+ <value>Retrofit EE</value>
199
+ <datatype>string</datatype>
200
+ </attribute>
201
+ </attributes>
202
+ <files>
203
+ <file>
204
+ <filename>TESCurves.idf</filename>
205
+ <filetype>idf</filetype>
206
+ <usage_type>resource</usage_type>
207
+ <checksum>E919566C</checksum>
208
+ </file>
209
+ <file>
210
+ <filename>MeasureTest.osm</filename>
211
+ <filetype>osm</filetype>
212
+ <usage_type>test</usage_type>
213
+ <checksum>DC0DCC4B</checksum>
214
+ </file>
215
+ <file>
216
+ <filename>LICENSE.md</filename>
217
+ <filetype>md</filetype>
218
+ <usage_type>license</usage_type>
219
+ <checksum>E0468DD6</checksum>
220
+ </file>
221
+ <file>
222
+ <filename>README.md</filename>
223
+ <filetype>md</filetype>
224
+ <usage_type>readme</usage_type>
225
+ <checksum>E6FBC489</checksum>
226
+ </file>
227
+ <file>
228
+ <filename>add_packaged_ice_storage_test.rb</filename>
229
+ <filetype>rb</filetype>
230
+ <usage_type>test</usage_type>
231
+ <checksum>B73245BC</checksum>
232
+ </file>
233
+ <file>
234
+ <version>
235
+ <software_program>OpenStudio</software_program>
236
+ <identifier>3.0.0</identifier>
237
+ <min_compatible>3.0.0</min_compatible>
238
+ </version>
239
+ <filename>measure.rb</filename>
240
+ <filetype>rb</filetype>
241
+ <usage_type>script</usage_type>
242
+ <checksum>4AE2C2E6</checksum>
243
+ </file>
244
+ </files>
245
+ </measure>