honeybee-openstudio 0 → 1.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (132) hide show
  1. checksums.yaml +5 -5
  2. data/.coveralls.yml +1 -0
  3. data/.gitignore +32 -33
  4. data/.releaserc.json +7 -7
  5. data/.travis.yml +41 -0
  6. data/Gemfile +18 -14
  7. data/LICENSE.md +23 -23
  8. data/README.md +95 -95
  9. data/Rakefile +21 -16
  10. data/doc_templates/LICENSE.md +23 -23
  11. data/doc_templates/copyright_erb.txt +31 -31
  12. data/doc_templates/copyright_js.txt +4 -4
  13. data/doc_templates/copyright_ruby.txt +29 -29
  14. data/honeybee-openstudio.gemspec +35 -38
  15. data/lib/files/Honeybee.rb +112 -112
  16. data/lib/files/honeybee_workflow.osw +47 -47
  17. data/lib/files/urbanopt_Gemfile +32 -32
  18. data/lib/{honeybee/_defaults → from_honeybee/_openapi}/model.json +8126 -11310
  19. data/lib/{honeybee/_defaults → from_honeybee/_openapi}/simulation-parameter.json +842 -972
  20. data/lib/{to_openstudio → from_honeybee}/construction/air.rb +65 -56
  21. data/lib/{to_openstudio → from_honeybee}/construction/opaque.rb +77 -67
  22. data/lib/{to_openstudio → from_honeybee}/construction/shade.rb +108 -99
  23. data/lib/{to_openstudio → from_honeybee}/construction/window.rb +80 -70
  24. data/lib/{to_openstudio → from_honeybee}/construction_set.rb +278 -266
  25. data/lib/{honeybee → from_honeybee}/extension.rb +109 -129
  26. data/lib/{to_openstudio → from_honeybee}/geometry/aperture.rb +167 -157
  27. data/lib/{to_openstudio → from_honeybee}/geometry/door.rb +160 -150
  28. data/lib/{to_openstudio → from_honeybee}/geometry/face.rb +163 -178
  29. data/lib/{to_openstudio → from_honeybee}/geometry/room.rb +392 -442
  30. data/lib/{to_openstudio → from_honeybee}/geometry/shade.rb +89 -79
  31. data/lib/{to_openstudio → from_honeybee}/hvac/ideal_air.rb +150 -141
  32. data/lib/{to_openstudio → from_honeybee}/load/electric_equipment.rb +96 -87
  33. data/lib/{to_openstudio → from_honeybee}/load/gas_equipment.rb +97 -88
  34. data/lib/{to_openstudio → from_honeybee}/load/infiltration.rb +94 -85
  35. data/lib/{to_openstudio → from_honeybee}/load/lighting.rb +98 -89
  36. data/lib/{to_openstudio → from_honeybee}/load/people.rb +100 -91
  37. data/lib/{to_openstudio → from_honeybee}/load/setpoint_humidistat.rb +75 -66
  38. data/lib/{to_openstudio → from_honeybee}/load/setpoint_thermostat.rb +71 -62
  39. data/lib/{to_openstudio → from_honeybee}/load/ventilation.rb +96 -87
  40. data/lib/{to_openstudio → from_honeybee}/material/opaque.rb +94 -85
  41. data/lib/{to_openstudio → from_honeybee}/material/opaque_no_mass.rb +94 -85
  42. data/lib/{to_openstudio → from_honeybee}/material/window_blind.rb +238 -229
  43. data/lib/{to_openstudio → from_honeybee}/material/window_gas.rb +76 -67
  44. data/lib/{to_openstudio → from_honeybee}/material/window_gas_custom.rb +118 -108
  45. data/lib/{to_openstudio → from_honeybee}/material/window_gas_mixture.rb +79 -70
  46. data/lib/{to_openstudio → from_honeybee}/material/window_glazing.rb +166 -157
  47. data/lib/{to_openstudio → from_honeybee}/material/window_shade.rb +160 -151
  48. data/lib/{to_openstudio → from_honeybee}/material/window_simpleglazsys.rb +73 -64
  49. data/lib/from_honeybee/model.rb +434 -0
  50. data/lib/{honeybee → from_honeybee}/model_object.rb +110 -108
  51. data/lib/{to_openstudio → from_honeybee}/program_type.rb +124 -104
  52. data/lib/{to_openstudio → from_honeybee}/schedule/fixed_interval.rb +115 -105
  53. data/lib/{to_openstudio → from_honeybee}/schedule/ruleset.rb +164 -164
  54. data/lib/{to_openstudio → from_honeybee}/schedule/type_limit.rb +88 -76
  55. data/lib/{to_openstudio/simulation/design_day.rb → from_honeybee/simulation/designday.rb} +105 -96
  56. data/lib/{honeybee/load/lighting.rb → from_honeybee/simulation/extension.rb} +46 -43
  57. data/lib/{to_openstudio/simulation/parameter_model.rb → from_honeybee/simulation/parameter.rb} +277 -243
  58. data/lib/{honeybee/simulation/design_day.rb → from_honeybee/version.rb} +34 -42
  59. data/lib/{honeybee.rb → from_honeybee.rb} +86 -93
  60. data/lib/measures/from_honeybee_model/LICENSE.md +27 -23
  61. data/lib/measures/from_honeybee_model/README.md +32 -32
  62. data/lib/measures/from_honeybee_model/measure.rb +91 -91
  63. data/lib/measures/from_honeybee_model/measure.xml +103 -80
  64. data/lib/measures/from_honeybee_model/tests/from_honeybee_model_test.rb +126 -126
  65. data/lib/measures/from_honeybee_simulation_parameter/LICENSE.md +27 -23
  66. data/lib/measures/from_honeybee_simulation_parameter/README.md +32 -32
  67. data/lib/measures/from_honeybee_simulation_parameter/measure.rb +95 -95
  68. data/lib/measures/from_honeybee_simulation_parameter/measure.xml +91 -86
  69. data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb +109 -109
  70. metadata +89 -147
  71. data/.github/workflows/ci.yaml +0 -88
  72. data/doc_templates/README.md.erb +0 -42
  73. data/lib/from_openstudio/geometry/aperture.rb +0 -136
  74. data/lib/from_openstudio/geometry/door.rb +0 -136
  75. data/lib/from_openstudio/geometry/face.rb +0 -174
  76. data/lib/from_openstudio/geometry/room.rb +0 -121
  77. data/lib/from_openstudio/geometry/shade.rb +0 -87
  78. data/lib/from_openstudio/model.rb +0 -123
  79. data/lib/from_openstudio/model_object.rb +0 -43
  80. data/lib/from_openstudio/simulation/design_day.rb +0 -123
  81. data/lib/from_openstudio/simulation/parameter_model.rb +0 -93
  82. data/lib/from_openstudio/simulation/simulation_output.rb +0 -67
  83. data/lib/from_openstudio.rb +0 -49
  84. data/lib/honeybee/_defaults/energy_default.json +0 -1682
  85. data/lib/honeybee/construction/air.rb +0 -42
  86. data/lib/honeybee/construction/opaque.rb +0 -42
  87. data/lib/honeybee/construction/shade.rb +0 -42
  88. data/lib/honeybee/construction/window.rb +0 -51
  89. data/lib/honeybee/construction/windowshade.rb +0 -43
  90. data/lib/honeybee/construction_set.rb +0 -42
  91. data/lib/honeybee/geometry/aperture.rb +0 -42
  92. data/lib/honeybee/geometry/door.rb +0 -42
  93. data/lib/honeybee/geometry/face.rb +0 -48
  94. data/lib/honeybee/geometry/room.rb +0 -56
  95. data/lib/honeybee/geometry/shade.rb +0 -42
  96. data/lib/honeybee/hvac/ideal_air.rb +0 -42
  97. data/lib/honeybee/hvac/template.rb +0 -73
  98. data/lib/honeybee/load/electric_equipment.rb +0 -42
  99. data/lib/honeybee/load/gas_equipment.rb +0 -42
  100. data/lib/honeybee/load/infiltration.rb +0 -42
  101. data/lib/honeybee/load/people.rb +0 -42
  102. data/lib/honeybee/load/setpoint_humidistat.rb +0 -46
  103. data/lib/honeybee/load/setpoint_thermostat.rb +0 -46
  104. data/lib/honeybee/load/ventilation.rb +0 -42
  105. data/lib/honeybee/material/opaque.rb +0 -42
  106. data/lib/honeybee/material/opaque_no_mass.rb +0 -42
  107. data/lib/honeybee/material/window_blind.rb +0 -42
  108. data/lib/honeybee/material/window_gas.rb +0 -42
  109. data/lib/honeybee/material/window_gas_custom.rb +0 -42
  110. data/lib/honeybee/material/window_gas_mixture.rb +0 -42
  111. data/lib/honeybee/material/window_glazing.rb +0 -42
  112. data/lib/honeybee/material/window_shade.rb +0 -42
  113. data/lib/honeybee/material/window_simpleglazsys.rb +0 -42
  114. data/lib/honeybee/model.rb +0 -87
  115. data/lib/honeybee/program_type.rb +0 -56
  116. data/lib/honeybee/schedule/fixed_interval.rb +0 -42
  117. data/lib/honeybee/schedule/ruleset.rb +0 -42
  118. data/lib/honeybee/schedule/type_limit.rb +0 -42
  119. data/lib/honeybee/simulation/parameter_model.rb +0 -86
  120. data/lib/honeybee/simulation/simulation_output.rb +0 -42
  121. data/lib/honeybee/ventcool/control.rb +0 -42
  122. data/lib/honeybee/ventcool/opening.rb +0 -46
  123. data/lib/honeybee/ventcool/simulation.rb +0 -42
  124. data/lib/to_openstudio/construction/windowshade.rb +0 -196
  125. data/lib/to_openstudio/hvac/Model.hvac.rb +0 -641
  126. data/lib/to_openstudio/hvac/template.rb +0 -169
  127. data/lib/to_openstudio/model.rb +0 -497
  128. data/lib/to_openstudio/model_object.rb +0 -52
  129. data/lib/to_openstudio/ventcool/control.rb +0 -185
  130. data/lib/to_openstudio/ventcool/opening.rb +0 -189
  131. data/lib/to_openstudio/ventcool/simulation.rb +0 -101
  132. data/lib/to_openstudio.rb +0 -92
data/lib/{honeybee/_defaults → from_honeybee/_openapi}/simulation-parameter.json RENAMED
@@ -1,973 +1,843 @@
1
- {
2
- "openapi": "3.0.2",
3
- "servers": [],
4
- "info": {
5
- "description": "This is the documentation for Honeybee energy simulation parameter schema.",
6
- "version": "1.36.0",
7
- "title": "Honeybee Energy Simulation Parameter Schema",
8
- "contact": {
9
- "name": "Ladybug Tools",
10
- "email": "info@ladybug.tools",
11
- "url": "https://github.com/ladybug-tools/honeybee-schema"
12
- },
13
- "x-logo": {
14
- "url": "https://www.ladybug.tools/assets/img/honeybee-large.png",
15
- "altText": "Honeybee logo"
16
- },
17
- "license": {
18
- "name": "BSD",
19
- "url": "https://github.com/ladybug-tools-in2/honeybee-schema/blob/master/LICENSE"
20
- }
21
- },
22
- "externalDocs": {
23
- "description": "OpenAPI Specification with Inheritance",
24
- "url": "./simulation-parameter_inheritance.json"
25
- },
26
- "tags": [
27
- {
28
- "name": "ashraeclearsky_model",
29
- "x-displayName": "ASHRAEClearSky",
30
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ASHRAEClearSky\" />\n"
31
- },
32
- {
33
- "name": "ashraetau_model",
34
- "x-displayName": "ASHRAETau",
35
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ASHRAETau\" />\n"
36
- },
37
- {
38
- "name": "calculationmethod_model",
39
- "x-displayName": "CalculationMethod",
40
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CalculationMethod\" />\n"
41
- },
42
- {
43
- "name": "calculationupdatemethod_model",
44
- "x-displayName": "CalculationUpdateMethod",
45
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CalculationUpdateMethod\" />\n"
46
- },
47
- {
48
- "name": "daylightsavingtime_model",
49
- "x-displayName": "DaylightSavingTime",
50
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DaylightSavingTime\" />\n"
51
- },
52
- {
53
- "name": "daysofweek_model",
54
- "x-displayName": "DaysOfWeek",
55
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DaysOfWeek\" />\n"
56
- },
57
- {
58
- "name": "designday_model",
59
- "x-displayName": "DesignDay",
60
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DesignDay\" />\n"
61
- },
62
- {
63
- "name": "designdaytypes_model",
64
- "x-displayName": "DesignDayTypes",
65
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DesignDayTypes\" />\n"
66
- },
67
- {
68
- "name": "drybulbcondition_model",
69
- "x-displayName": "DryBulbCondition",
70
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DryBulbCondition\" />\n"
71
- },
72
- {
73
- "name": "humiditycondition_model",
74
- "x-displayName": "HumidityCondition",
75
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/HumidityCondition\" />\n"
76
- },
77
- {
78
- "name": "humiditytypes_model",
79
- "x-displayName": "HumidityTypes",
80
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/HumidityTypes\" />\n"
81
- },
82
- {
83
- "name": "reportingfrequency_model",
84
- "x-displayName": "ReportingFrequency",
85
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ReportingFrequency\" />\n"
86
- },
87
- {
88
- "name": "runperiod_model",
89
- "x-displayName": "RunPeriod",
90
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RunPeriod\" />\n"
91
- },
92
- {
93
- "name": "shadowcalculation_model",
94
- "x-displayName": "ShadowCalculation",
95
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadowCalculation\" />\n"
96
- },
97
- {
98
- "name": "simulationcontrol_model",
99
- "x-displayName": "SimulationControl",
100
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SimulationControl\" />\n"
101
- },
102
- {
103
- "name": "simulationoutput_model",
104
- "x-displayName": "SimulationOutput",
105
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SimulationOutput\" />\n"
106
- },
107
- {
108
- "name": "simulationparameter_model",
109
- "x-displayName": "SimulationParameter",
110
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SimulationParameter\" />\n"
111
- },
112
- {
113
- "name": "sizingparameter_model",
114
- "x-displayName": "SizingParameter",
115
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SizingParameter\" />\n"
116
- },
117
- {
118
- "name": "solardistribution_model",
119
- "x-displayName": "SolarDistribution",
120
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SolarDistribution\" />\n"
121
- },
122
- {
123
- "name": "terriantypes_model",
124
- "x-displayName": "TerrianTypes",
125
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/TerrianTypes\" />\n"
126
- },
127
- {
128
- "name": "windcondition_model",
129
- "x-displayName": "WindCondition",
130
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindCondition\" />\n"
131
- }
132
- ],
133
- "x-tagGroups": [
134
- {
135
- "name": "Models",
136
- "tags": [
137
- "ashraeclearsky_model",
138
- "ashraetau_model",
139
- "calculationmethod_model",
140
- "calculationupdatemethod_model",
141
- "daylightsavingtime_model",
142
- "daysofweek_model",
143
- "designday_model",
144
- "designdaytypes_model",
145
- "drybulbcondition_model",
146
- "humiditycondition_model",
147
- "humiditytypes_model",
148
- "reportingfrequency_model",
149
- "runperiod_model",
150
- "shadowcalculation_model",
151
- "simulationcontrol_model",
152
- "simulationoutput_model",
153
- "simulationparameter_model",
154
- "sizingparameter_model",
155
- "solardistribution_model",
156
- "terriantypes_model",
157
- "windcondition_model"
158
- ]
159
- }
160
- ],
161
- "paths": {},
162
- "components": {
163
- "schemas": {
164
- "ReportingFrequency": {
165
- "title": "ReportingFrequency",
166
- "description": "An enumeration.",
167
- "enum": [
168
- "Timestep",
169
- "Hourly",
170
- "Daily",
171
- "Monthly",
172
- "Annual"
173
- ],
174
- "type": "string"
175
- },
176
- "SimulationOutput": {
177
- "title": "SimulationOutput",
178
- "description": "Lists the outputs to report from the simulation and their format.",
179
- "type": "object",
180
- "properties": {
181
- "type": {
182
- "title": "Type",
183
- "default": "SimulationOutput",
184
- "pattern": "^SimulationOutput$",
185
- "type": "string",
186
- "readOnly": true
187
- },
188
- "reporting_frequency": {
189
- "title": "Reporting Frequency",
190
- "default": "Hourly",
191
- "allOf": [
192
- {
193
- "$ref": "#/components/schemas/ReportingFrequency"
194
- }
195
- ]
196
- },
197
- "include_sqlite": {
198
- "title": "Include Sqlite",
199
- "description": "Boolean to note whether a SQLite report should be requested from the simulation.",
200
- "default": true,
201
- "type": "boolean"
202
- },
203
- "include_html": {
204
- "title": "Include Html",
205
- "description": "Boolean to note whether an HTML report should be requested from the simulation.",
206
- "default": true,
207
- "type": "boolean"
208
- },
209
- "outputs": {
210
- "title": "Outputs",
211
- "description": "A list of EnergyPlus output names as strings, which are requested from the simulation.",
212
- "type": "array",
213
- "items": {
214
- "type": "string"
215
- }
216
- },
217
- "summary_reports": {
218
- "title": "Summary Reports",
219
- "description": "A list of EnergyPlus summary report names as strings.",
220
- "type": "array",
221
- "items": {
222
- "type": "string"
223
- }
224
- }
225
- },
226
- "additionalProperties": false
227
- },
228
- "DaysOfWeek": {
229
- "title": "DaysOfWeek",
230
- "description": "An enumeration.",
231
- "enum": [
232
- "Sunday",
233
- "Monday",
234
- "Tuesday",
235
- "Wednesday",
236
- "Thursday",
237
- "Friday",
238
- "Saturday"
239
- ],
240
- "type": "string"
241
- },
242
- "DaylightSavingTime": {
243
- "title": "DaylightSavingTime",
244
- "description": "Used to describe the daylight savings time for the simulation.",
245
- "type": "object",
246
- "properties": {
247
- "type": {
248
- "title": "Type",
249
- "default": "DaylightSavingTime",
250
- "pattern": "^DaylightSavingTime$",
251
- "type": "string",
252
- "readOnly": true
253
- },
254
- "start_date": {
255
- "title": "Start Date",
256
- "description": "A list of two integers for [month, day], representing the date for the start of daylight savings time. Default: 12 Mar (daylight savings in the US in 2017).",
257
- "default": [
258
- 3,
259
- 12
260
- ],
261
- "minItems": 2,
262
- "maxItems": 3,
263
- "type": "array",
264
- "items": {
265
- "type": "integer",
266
- "format": "int32"
267
- }
268
- },
269
- "end_date": {
270
- "title": "End Date",
271
- "description": "A list of two integers for [month, day], representing the date for the end of daylight savings time. Default: 5 Nov (daylight savings in the US in 2017).",
272
- "default": [
273
- 11,
274
- 5
275
- ],
276
- "minItems": 2,
277
- "maxItems": 3,
278
- "type": "array",
279
- "items": {
280
- "type": "integer",
281
- "format": "int32"
282
- }
283
- }
284
- },
285
- "additionalProperties": false
286
- },
287
- "RunPeriod": {
288
- "title": "RunPeriod",
289
- "description": "Used to describe the time period over which to run the simulation.",
290
- "type": "object",
291
- "properties": {
292
- "type": {
293
- "title": "Type",
294
- "default": "RunPeriod",
295
- "pattern": "^RunPeriod$",
296
- "type": "string",
297
- "readOnly": true
298
- },
299
- "start_date": {
300
- "title": "Start Date",
301
- "description": "A list of two integers for [month, day], representing the date for the start of the run period. Must be before the end date.",
302
- "default": [
303
- 1,
304
- 1
305
- ],
306
- "minItems": 2,
307
- "maxItems": 2,
308
- "type": "array",
309
- "items": {
310
- "type": "integer",
311
- "format": "int32"
312
- }
313
- },
314
- "end_date": {
315
- "title": "End Date",
316
- "description": "A list of two integers for [month, day], representing the date for the end of the run period. Must be after the start date.",
317
- "default": [
318
- 12,
319
- 31
320
- ],
321
- "minItems": 2,
322
- "maxItems": 2,
323
- "type": "array",
324
- "items": {
325
- "type": "integer",
326
- "format": "int32"
327
- }
328
- },
329
- "start_day_of_week": {
330
- "title": "Start Day Of Week",
331
- "description": "Text for the day of the week on which the simulation starts.",
332
- "default": "Sunday",
333
- "allOf": [
334
- {
335
- "$ref": "#/components/schemas/DaysOfWeek"
336
- }
337
- ]
338
- },
339
- "holidays": {
340
- "title": "Holidays",
341
- "description": "A list of lists where each sub-list consists of two integers for [month, day], representing a date which is a holiday within the simulation. If None, no holidays are applied.",
342
- "type": "array",
343
- "items": {
344
- "type": "array",
345
- "items": {
346
- "type": "integer",
347
- "format": "int32"
348
- },
349
- "minItems": 2,
350
- "maxItems": 2
351
- }
352
- },
353
- "daylight_saving_time": {
354
- "title": "Daylight Saving Time",
355
- "description": "A DaylightSavingTime to dictate the start and end dates of daylight saving time. If None, no daylight saving time is applied to the simulation.",
356
- "allOf": [
357
- {
358
- "$ref": "#/components/schemas/DaylightSavingTime"
359
- }
360
- ]
361
- },
362
- "leap_year": {
363
- "title": "Leap Year",
364
- "description": "Boolean noting whether the simulation will be run for a leap year.",
365
- "default": false,
366
- "type": "boolean"
367
- }
368
- },
369
- "additionalProperties": false
370
- },
371
- "SimulationControl": {
372
- "title": "SimulationControl",
373
- "description": "Used to specify which types of calculations to run.",
374
- "type": "object",
375
- "properties": {
376
- "type": {
377
- "title": "Type",
378
- "default": "SimulationControl",
379
- "pattern": "^SimulationControl$",
380
- "type": "string",
381
- "readOnly": true
382
- },
383
- "do_zone_sizing": {
384
- "title": "Do Zone Sizing",
385
- "description": "Boolean for whether the zone sizing calculation should be run.",
386
- "default": true,
387
- "type": "boolean"
388
- },
389
- "do_system_sizing": {
390
- "title": "Do System Sizing",
391
- "description": "Boolean for whether the system sizing calculation should be run.",
392
- "default": true,
393
- "type": "boolean"
394
- },
395
- "do_plant_sizing": {
396
- "title": "Do Plant Sizing",
397
- "description": "Boolean for whether the plant sizing calculation should be run.",
398
- "default": true,
399
- "type": "boolean"
400
- },
401
- "run_for_run_periods": {
402
- "title": "Run For Run Periods",
403
- "description": "Boolean for whether the simulation should be run for the sizing periods.",
404
- "default": true,
405
- "type": "boolean"
406
- },
407
- "run_for_sizing_periods": {
408
- "title": "Run For Sizing Periods",
409
- "description": "Boolean for whether the simulation should be run for the run periods.",
410
- "default": false,
411
- "type": "boolean"
412
- }
413
- },
414
- "additionalProperties": false
415
- },
416
- "SolarDistribution": {
417
- "title": "SolarDistribution",
418
- "description": "An enumeration.",
419
- "enum": [
420
- "MinimalShadowing",
421
- "FullExterior",
422
- "FullInteriorAndExterior",
423
- "FullExteriorWithReflections",
424
- "FullInteriorAndExteriorWithReflections"
425
- ],
426
- "type": "string"
427
- },
428
- "CalculationMethod": {
429
- "title": "CalculationMethod",
430
- "description": "An enumeration.",
431
- "enum": [
432
- "PolygonClipping",
433
- "PixelCounting"
434
- ],
435
- "type": "string"
436
- },
437
- "CalculationUpdateMethod": {
438
- "title": "CalculationUpdateMethod",
439
- "description": "An enumeration.",
440
- "enum": [
441
- "Periodic",
442
- "Timestep"
443
- ],
444
- "type": "string"
445
- },
446
- "ShadowCalculation": {
447
- "title": "ShadowCalculation",
448
- "description": "Used to describe settings for EnergyPlus shadow calculation.",
449
- "type": "object",
450
- "properties": {
451
- "type": {
452
- "title": "Type",
453
- "default": "ShadowCalculation",
454
- "pattern": "^ShadowCalculation$",
455
- "type": "string",
456
- "readOnly": true
457
- },
458
- "solar_distribution": {
459
- "title": "Solar Distribution",
460
- "default": "FullExteriorWithReflections",
461
- "allOf": [
462
- {
463
- "$ref": "#/components/schemas/SolarDistribution"
464
- }
465
- ]
466
- },
467
- "calculation_method": {
468
- "title": "Calculation Method",
469
- "description": "Text noting whether CPU-based polygon clipping method orGPU-based pixel counting method should be used. For low numbers of shadingsurfaces (less than ~200), PolygonClipping requires less runtime thanPixelCounting. However, PixelCounting runtime scales significantlybetter at higher numbers of shading surfaces. PixelCounting also hasno limitations related to zone concavity when used with any\u201cFullInterior\u201d solar distribution options.",
470
- "default": "PolygonClipping",
471
- "allOf": [
472
- {
473
- "$ref": "#/components/schemas/CalculationMethod"
474
- }
475
- ]
476
- },
477
- "calculation_update_method": {
478
- "title": "Calculation Update Method",
479
- "description": "Text describing how often the solar and shading calculations are updated with respect to the flow of time in the simulation.",
480
- "default": "Periodic",
481
- "allOf": [
482
- {
483
- "$ref": "#/components/schemas/CalculationUpdateMethod"
484
- }
485
- ]
486
- },
487
- "calculation_frequency": {
488
- "title": "Calculation Frequency",
489
- "description": "Integer for the number of days in each period for which a unique shadow calculation will be performed. This field is only used if the Periodic calculation_method is used.",
490
- "default": 30,
491
- "minimum": 1,
492
- "type": "integer",
493
- "format": "int32"
494
- },
495
- "maximum_figures": {
496
- "title": "Maximum Figures",
497
- "description": "Number of allowable figures in shadow overlap calculations.",
498
- "default": 15000,
499
- "minimum": 200,
500
- "type": "integer",
501
- "format": "int32"
502
- }
503
- },
504
- "additionalProperties": false
505
- },
506
- "DesignDayTypes": {
507
- "title": "DesignDayTypes",
508
- "description": "An enumeration.",
509
- "enum": [
510
- "SummerDesignDay",
511
- "WinterDesignDay",
512
- "Sunday",
513
- "Monday",
514
- "Tuesday",
515
- "Wednesday",
516
- "Thursday",
517
- "Friday",
518
- "Saturday",
519
- "Holiday",
520
- "CustomDay1",
521
- "CustomDay2"
522
- ],
523
- "type": "string"
524
- },
525
- "DryBulbCondition": {
526
- "title": "DryBulbCondition",
527
- "description": "Used to specify dry bulb conditions on a design day.",
528
- "type": "object",
529
- "properties": {
530
- "dry_bulb_max": {
531
- "title": "Dry Bulb Max",
532
- "description": "The maximum dry bulb temperature on the design day [C].",
533
- "minimum": -90,
534
- "maximum": 70,
535
- "type": "number",
536
- "format": "double"
537
- },
538
- "dry_bulb_range": {
539
- "title": "Dry Bulb Range",
540
- "description": "The difference between min and max temperatures on the design day [C].",
541
- "minimum": 0,
542
- "type": "number",
543
- "format": "double"
544
- },
545
- "type": {
546
- "title": "Type",
547
- "default": "DryBulbCondition",
548
- "pattern": "^DryBulbCondition$",
549
- "type": "string",
550
- "readOnly": true
551
- }
552
- },
553
- "required": [
554
- "dry_bulb_max",
555
- "dry_bulb_range"
556
- ],
557
- "additionalProperties": false
558
- },
559
- "HumidityTypes": {
560
- "title": "HumidityTypes",
561
- "description": "An enumeration.",
562
- "enum": [
563
- "Wetbulb",
564
- "Dewpoint",
565
- "HumidityRatio",
566
- "Enthalpy"
567
- ],
568
- "type": "string"
569
- },
570
- "HumidityCondition": {
571
- "title": "HumidityCondition",
572
- "description": "Used to specify humidity conditions on a design day.",
573
- "type": "object",
574
- "properties": {
575
- "humidity_type": {
576
- "title": "Humidity Type",
577
- "allOf": [
578
- {
579
- "$ref": "#/components/schemas/HumidityTypes"
580
- }
581
- ]
582
- },
583
- "humidity_value": {
584
- "title": "Humidity Value",
585
- "description": "The value correcponding to the humidity_type.",
586
- "type": "number",
587
- "format": "double"
588
- },
589
- "type": {
590
- "title": "Type",
591
- "default": "HumidityCondition",
592
- "pattern": "^HumidityCondition$",
593
- "type": "string",
594
- "readOnly": true
595
- },
596
- "barometric_pressure": {
597
- "title": "Barometric Pressure",
598
- "description": "Barometric air pressure on the design day [Pa].",
599
- "default": 101325,
600
- "minimum": 31000,
601
- "maximum": 120000,
602
- "type": "number",
603
- "format": "double"
604
- },
605
- "rain": {
606
- "title": "Rain",
607
- "description": "Boolean to indicate rain on the design day.",
608
- "default": false,
609
- "type": "boolean"
610
- },
611
- "snow_on_ground": {
612
- "title": "Snow On Ground",
613
- "description": "Boolean to indicate snow on the ground during the design day.",
614
- "default": false,
615
- "type": "boolean"
616
- }
617
- },
618
- "required": [
619
- "humidity_type",
620
- "humidity_value"
621
- ],
622
- "additionalProperties": false
623
- },
624
- "WindCondition": {
625
- "title": "WindCondition",
626
- "description": "Used to specify wind conditions on a design day.",
627
- "type": "object",
628
- "properties": {
629
- "wind_speed": {
630
- "title": "Wind Speed",
631
- "description": "Wind speed on the design day [m/s].",
632
- "minimum": 0,
633
- "maximum": 40,
634
- "type": "number",
635
- "format": "double"
636
- },
637
- "type": {
638
- "title": "Type",
639
- "default": "WindCondition",
640
- "pattern": "^WindCondition$",
641
- "type": "string",
642
- "readOnly": true
643
- },
644
- "wind_direction": {
645
- "title": "Wind Direction",
646
- "description": "Wind direction on the design day [degrees].",
647
- "default": 0,
648
- "minimum": 0,
649
- "maximum": 360,
650
- "type": "number",
651
- "format": "double"
652
- }
653
- },
654
- "required": [
655
- "wind_speed"
656
- ],
657
- "additionalProperties": false
658
- },
659
- "ASHRAEClearSky": {
660
- "title": "ASHRAEClearSky",
661
- "description": "Used to specify sky conditions on a design day.",
662
- "type": "object",
663
- "properties": {
664
- "date": {
665
- "title": "Date",
666
- "description": "A list of two integers for [month, day], representing the date for the day of the year on which the design day occurs. A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
667
- "minItems": 2,
668
- "maxItems": 3,
669
- "type": "array",
670
- "items": {
671
- "type": "integer",
672
- "format": "int32"
673
- }
674
- },
675
- "clearness": {
676
- "title": "Clearness",
677
- "description": "Value between 0 and 1.2 that will get multiplied by the irradiance to correct for factors like elevation above sea level.",
678
- "minimum": 0,
679
- "maximum": 1.2,
680
- "type": "number",
681
- "format": "double"
682
- },
683
- "daylight_savings": {
684
- "title": "Daylight Savings",
685
- "description": "Boolean to indicate whether daylight savings time is active on the design day.",
686
- "default": false,
687
- "type": "boolean"
688
- },
689
- "type": {
690
- "title": "Type",
691
- "default": "ASHRAEClearSky",
692
- "pattern": "^ASHRAEClearSky$",
693
- "type": "string",
694
- "readOnly": true
695
- }
696
- },
697
- "required": [
698
- "date",
699
- "clearness"
700
- ],
701
- "additionalProperties": false
702
- },
703
- "ASHRAETau": {
704
- "title": "ASHRAETau",
705
- "description": "Used to specify sky conditions on a design day.",
706
- "type": "object",
707
- "properties": {
708
- "date": {
709
- "title": "Date",
710
- "description": "A list of two integers for [month, day], representing the date for the day of the year on which the design day occurs. A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
711
- "minItems": 2,
712
- "maxItems": 3,
713
- "type": "array",
714
- "items": {
715
- "type": "integer",
716
- "format": "int32"
717
- }
718
- },
719
- "tau_b": {
720
- "title": "Tau B",
721
- "description": "Value for the beam optical depth. Typically found in .stat files.",
722
- "minimum": 0,
723
- "maximum": 1.2,
724
- "type": "number",
725
- "format": "double"
726
- },
727
- "tau_d": {
728
- "title": "Tau D",
729
- "description": "Value for the diffuse optical depth. Typically found in .stat files.",
730
- "minimum": 0,
731
- "maximum": 3,
732
- "type": "number",
733
- "format": "double"
734
- },
735
- "daylight_savings": {
736
- "title": "Daylight Savings",
737
- "description": "Boolean to indicate whether daylight savings time is active on the design day.",
738
- "default": false,
739
- "type": "boolean"
740
- },
741
- "type": {
742
- "title": "Type",
743
- "default": "ASHRAETau",
744
- "pattern": "^ASHRAETau$",
745
- "type": "string",
746
- "readOnly": true
747
- }
748
- },
749
- "required": [
750
- "date",
751
- "tau_b",
752
- "tau_d"
753
- ],
754
- "additionalProperties": false
755
- },
756
- "DesignDay": {
757
- "title": "DesignDay",
758
- "description": "An object representing design day conditions.",
759
- "type": "object",
760
- "properties": {
761
- "name": {
762
- "title": "Name",
763
- "description": "Text string for a unique design day name. This name remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). It is also used to reference the object within SimulationParameters. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
764
- "maxLength": 100,
765
- "minLength": 1,
766
- "type": "string"
767
- },
768
- "day_type": {
769
- "title": "Day Type",
770
- "allOf": [
771
- {
772
- "$ref": "#/components/schemas/DesignDayTypes"
773
- }
774
- ]
775
- },
776
- "dry_bulb_condition": {
777
- "title": "Dry Bulb Condition",
778
- "description": "A DryBulbCondition describing temperature conditions on the design day.",
779
- "allOf": [
780
- {
781
- "$ref": "#/components/schemas/DryBulbCondition"
782
- }
783
- ]
784
- },
785
- "humidity_condition": {
786
- "title": "Humidity Condition",
787
- "description": "A HumidityCondition describing humidity and precipitation conditions on the design day.",
788
- "allOf": [
789
- {
790
- "$ref": "#/components/schemas/HumidityCondition"
791
- }
792
- ]
793
- },
794
- "wind_condition": {
795
- "title": "Wind Condition",
796
- "description": "A WindCondition describing wind conditions on the design day.",
797
- "allOf": [
798
- {
799
- "$ref": "#/components/schemas/WindCondition"
800
- }
801
- ]
802
- },
803
- "sky_condition": {
804
- "title": "Sky Condition",
805
- "anyOf": [
806
- {
807
- "$ref": "#/components/schemas/ASHRAEClearSky"
808
- },
809
- {
810
- "$ref": "#/components/schemas/ASHRAETau"
811
- }
812
- ]
813
- },
814
- "type": {
815
- "title": "Type",
816
- "default": "DesignDay",
817
- "pattern": "^DesignDay$",
818
- "type": "string",
819
- "readOnly": true
820
- }
821
- },
822
- "required": [
823
- "name",
824
- "day_type",
825
- "dry_bulb_condition",
826
- "humidity_condition",
827
- "wind_condition",
828
- "sky_condition"
829
- ],
830
- "additionalProperties": false
831
- },
832
- "SizingParameter": {
833
- "title": "SizingParameter",
834
- "description": "Used to specify heating and cooling sizing criteria and safety factors.",
835
- "type": "object",
836
- "properties": {
837
- "type": {
838
- "title": "Type",
839
- "default": "SizingParameter",
840
- "pattern": "^SizingParameter$",
841
- "type": "string",
842
- "readOnly": true
843
- },
844
- "design_days": {
845
- "title": "Design Days",
846
- "description": "A list of DesignDays that represent the criteria for which the HVAC systems will be sized.",
847
- "type": "array",
848
- "items": {
849
- "$ref": "#/components/schemas/DesignDay"
850
- }
851
- },
852
- "heating_factor": {
853
- "title": "Heating Factor",
854
- "description": "A number that will be multiplied by the peak heating load for each zone in order to size the heating system.",
855
- "default": 1.25,
856
- "exclusiveMinimum": 0,
857
- "type": "number",
858
- "format": "double"
859
- },
860
- "cooling_factor": {
861
- "title": "Cooling Factor",
862
- "description": "A number that will be multiplied by the peak cooling load for each zone in order to size the heating system.",
863
- "default": 1.15,
864
- "exclusiveMinimum": 0,
865
- "type": "number",
866
- "format": "double"
867
- }
868
- },
869
- "additionalProperties": false
870
- },
871
- "TerrianTypes": {
872
- "title": "TerrianTypes",
873
- "description": "An enumeration.",
874
- "enum": [
875
- "Ocean",
876
- "Country",
877
- "Suburbs",
878
- "Urban",
879
- "City"
880
- ],
881
- "type": "string"
882
- },
883
- "SimulationParameter": {
884
- "title": "SimulationParameter",
885
- "description": "The complete set of EnergyPlus Simulation Settings.",
886
- "type": "object",
887
- "properties": {
888
- "type": {
889
- "title": "Type",
890
- "default": "SimulationParameter",
891
- "pattern": "^SimulationParameter$",
892
- "type": "string",
893
- "readOnly": true
894
- },
895
- "output": {
896
- "title": "Output",
897
- "description": "A SimulationOutput that lists the desired outputs from the simulation and the format in which to report them.",
898
- "allOf": [
899
- {
900
- "$ref": "#/components/schemas/SimulationOutput"
901
- }
902
- ]
903
- },
904
- "run_period": {
905
- "title": "Run Period",
906
- "description": "A RunPeriod to describe the time period over which to run the simulation.",
907
- "allOf": [
908
- {
909
- "$ref": "#/components/schemas/RunPeriod"
910
- }
911
- ]
912
- },
913
- "timestep": {
914
- "title": "Timestep",
915
- "description": "An integer for the number of timesteps per hour at which the energy calculation will be run.",
916
- "default": 6,
917
- "minimum": 1,
918
- "maximum": 60,
919
- "type": "integer",
920
- "format": "int32"
921
- },
922
- "simulation_control": {
923
- "title": "Simulation Control",
924
- "description": "A SimulationControl object that describes which types of calculations to run.",
925
- "allOf": [
926
- {
927
- "$ref": "#/components/schemas/SimulationControl"
928
- }
929
- ]
930
- },
931
- "shadow_calculation": {
932
- "title": "Shadow Calculation",
933
- "description": "A ShadowCalculation object describing settings for the EnergyPlus Shadow Calculation.",
934
- "allOf": [
935
- {
936
- "$ref": "#/components/schemas/ShadowCalculation"
937
- }
938
- ]
939
- },
940
- "sizing_parameter": {
941
- "title": "Sizing Parameter",
942
- "description": "A SizingParameter object with criteria for sizing the heating and cooling system.",
943
- "allOf": [
944
- {
945
- "$ref": "#/components/schemas/SizingParameter"
946
- }
947
- ]
948
- },
949
- "north_angle": {
950
- "title": "North Angle",
951
- "description": "A number between -360 and 360 for the north direction in degrees.This is the counterclockwise difference between the North and the positive Y-axis. 90 is West and 270 is East. Note that this is different than the convention used in EnergyPlus, which uses clockwise difference instead of counterclockwise difference.",
952
- "default": 0,
953
- "exclusiveMaximum": 360,
954
- "minimum": -360,
955
- "type": "number",
956
- "format": "double"
957
- },
958
- "terrain_type": {
959
- "title": "Terrain Type",
960
- "description": "Text for the terrain in which the model sits. This is used to determine the wind profile over the height of the rooms.",
961
- "default": "City",
962
- "allOf": [
963
- {
964
- "$ref": "#/components/schemas/TerrianTypes"
965
- }
966
- ]
967
- }
968
- },
969
- "additionalProperties": false
970
- }
971
- }
972
- }
1
+ {
2
+ "openapi": "3.0.2",
3
+ "servers": [],
4
+ "info": {
5
+ "description": "This is the documentation for Honeybee energy simulation parameter schema.",
6
+ "version": "1.27.1",
7
+ "title": "Honeybee Energy Simulation Parameter Schema",
8
+ "contact": {
9
+ "name": "Ladybug Tools",
10
+ "email": "info@ladybug.tools",
11
+ "url": "https://github.com/ladybug-tools/honeybee-schema"
12
+ },
13
+ "x-logo": {
14
+ "url": "https://www.ladybug.tools/assets/img/honeybee-large.png",
15
+ "altText": "Honeybee logo"
16
+ },
17
+ "license": {
18
+ "name": "BSD",
19
+ "url": "https://github.com/ladybug-tools-in2/honeybee-schema/blob/master/LICENSE"
20
+ }
21
+ },
22
+ "externalDocs": {
23
+ "description": "OpenAPI Specification with Inheritance",
24
+ "url": "./simulation-parameter_inheritance.json"
25
+ },
26
+ "tags": [
27
+ {
28
+ "name": "ashraeclearsky_model",
29
+ "x-displayName": "ASHRAEClearSky",
30
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ASHRAEClearSky\" />\n"
31
+ },
32
+ {
33
+ "name": "ashraetau_model",
34
+ "x-displayName": "ASHRAETau",
35
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ASHRAETau\" />\n"
36
+ },
37
+ {
38
+ "name": "daylightsavingtime_model",
39
+ "x-displayName": "DaylightSavingTime",
40
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DaylightSavingTime\" />\n"
41
+ },
42
+ {
43
+ "name": "designday_model",
44
+ "x-displayName": "DesignDay",
45
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DesignDay\" />\n"
46
+ },
47
+ {
48
+ "name": "drybulbcondition_model",
49
+ "x-displayName": "DryBulbCondition",
50
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DryBulbCondition\" />\n"
51
+ },
52
+ {
53
+ "name": "humiditycondition_model",
54
+ "x-displayName": "HumidityCondition",
55
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/HumidityCondition\" />\n"
56
+ },
57
+ {
58
+ "name": "runperiod_model",
59
+ "x-displayName": "RunPeriod",
60
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RunPeriod\" />\n"
61
+ },
62
+ {
63
+ "name": "shadowcalculation_model",
64
+ "x-displayName": "ShadowCalculation",
65
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadowCalculation\" />\n"
66
+ },
67
+ {
68
+ "name": "simulationcontrol_model",
69
+ "x-displayName": "SimulationControl",
70
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SimulationControl\" />\n"
71
+ },
72
+ {
73
+ "name": "simulationoutput_model",
74
+ "x-displayName": "SimulationOutput",
75
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SimulationOutput\" />\n"
76
+ },
77
+ {
78
+ "name": "simulationparameter_model",
79
+ "x-displayName": "SimulationParameter",
80
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SimulationParameter\" />\n"
81
+ },
82
+ {
83
+ "name": "sizingparameter_model",
84
+ "x-displayName": "SizingParameter",
85
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SizingParameter\" />\n"
86
+ },
87
+ {
88
+ "name": "windcondition_model",
89
+ "x-displayName": "WindCondition",
90
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindCondition\" />\n"
91
+ }
92
+ ],
93
+ "x-tagGroups": [
94
+ {
95
+ "name": "Models",
96
+ "tags": [
97
+ "ashraeclearsky_model",
98
+ "ashraetau_model",
99
+ "daylightsavingtime_model",
100
+ "designday_model",
101
+ "drybulbcondition_model",
102
+ "humiditycondition_model",
103
+ "runperiod_model",
104
+ "shadowcalculation_model",
105
+ "simulationcontrol_model",
106
+ "simulationoutput_model",
107
+ "simulationparameter_model",
108
+ "sizingparameter_model",
109
+ "windcondition_model"
110
+ ]
111
+ }
112
+ ],
113
+ "paths": {},
114
+ "components": {
115
+ "schemas": {
116
+ "SimulationOutput": {
117
+ "title": "SimulationOutput",
118
+ "description": "Lists the outputs to report from the simulation and their format.",
119
+ "type": "object",
120
+ "properties": {
121
+ "type": {
122
+ "title": "Type",
123
+ "default": "SimulationOutput",
124
+ "pattern": "^SimulationOutput$",
125
+ "type": "string",
126
+ "readOnly": true
127
+ },
128
+ "reporting_frequency": {
129
+ "title": "Reporting Frequency",
130
+ "default": "Hourly",
131
+ "enum": [
132
+ "Timestep",
133
+ "Hourly",
134
+ "Daily",
135
+ "Monthly",
136
+ "Annual"
137
+ ],
138
+ "type": "string"
139
+ },
140
+ "include_sqlite": {
141
+ "title": "Include Sqlite",
142
+ "description": "Boolean to note whether a SQLite report should be requested from the simulation.",
143
+ "default": true,
144
+ "type": "boolean"
145
+ },
146
+ "include_html": {
147
+ "title": "Include Html",
148
+ "description": "Boolean to note whether an HTML report should be requested from the simulation.",
149
+ "default": false,
150
+ "type": "boolean"
151
+ },
152
+ "outputs": {
153
+ "title": "Outputs",
154
+ "description": "A list of EnergyPlus output names as strings, which are requested from the simulation.",
155
+ "type": "array",
156
+ "items": {
157
+ "type": "string"
158
+ }
159
+ },
160
+ "summary_reports": {
161
+ "title": "Summary Reports",
162
+ "description": "A list of EnergyPlus summary report names as strings.",
163
+ "type": "array",
164
+ "items": {
165
+ "type": "string"
166
+ }
167
+ }
168
+ },
169
+ "additionalProperties": false
170
+ },
171
+ "DaylightSavingTime": {
172
+ "title": "DaylightSavingTime",
173
+ "description": "Used to describe the daylight savings time for the simulation.",
174
+ "type": "object",
175
+ "properties": {
176
+ "type": {
177
+ "title": "Type",
178
+ "default": "DaylightSavingTime",
179
+ "pattern": "^DaylightSavingTime$",
180
+ "type": "string",
181
+ "readOnly": true
182
+ },
183
+ "start_date": {
184
+ "title": "Start Date",
185
+ "description": "A list of two integers for [month, day], representing the date for the start of daylight savings time. Default: 12 Mar (daylight savings in the US in 2017).",
186
+ "default": [
187
+ 3,
188
+ 12
189
+ ],
190
+ "type": "array",
191
+ "items": {
192
+ "type": "integer",
193
+ "format": "int32"
194
+ },
195
+ "minItems": 2,
196
+ "maxItems": 3
197
+ },
198
+ "end_date": {
199
+ "title": "End Date",
200
+ "description": "A list of two integers for [month, day], representing the date for the end of daylight savings time. Default: 5 Nov (daylight savings in the US in 2017).",
201
+ "default": [
202
+ 11,
203
+ 5
204
+ ],
205
+ "type": "array",
206
+ "items": {
207
+ "type": "integer",
208
+ "format": "int32"
209
+ },
210
+ "minItems": 2,
211
+ "maxItems": 3
212
+ }
213
+ },
214
+ "additionalProperties": false
215
+ },
216
+ "RunPeriod": {
217
+ "title": "RunPeriod",
218
+ "description": "Used to describe the time period over which to run the simulation.",
219
+ "type": "object",
220
+ "properties": {
221
+ "type": {
222
+ "title": "Type",
223
+ "default": "RunPeriod",
224
+ "pattern": "^RunPeriod$",
225
+ "type": "string",
226
+ "readOnly": true
227
+ },
228
+ "start_date": {
229
+ "title": "Start Date",
230
+ "description": "A list of two integers for [month, day], representing the date for the start of the run period. Must be before the end date.",
231
+ "default": [
232
+ 1,
233
+ 1
234
+ ],
235
+ "type": "array",
236
+ "items": {
237
+ "type": "integer",
238
+ "format": "int32"
239
+ },
240
+ "minItems": 2,
241
+ "maxItems": 2
242
+ },
243
+ "end_date": {
244
+ "title": "End Date",
245
+ "description": "A list of two integers for [month, day], representing the date for the end of the run period. Must be after the start date.",
246
+ "default": [
247
+ 12,
248
+ 31
249
+ ],
250
+ "type": "array",
251
+ "items": {
252
+ "type": "integer",
253
+ "format": "int32"
254
+ },
255
+ "minItems": 2,
256
+ "maxItems": 2
257
+ },
258
+ "start_day_of_week": {
259
+ "title": "Start Day Of Week",
260
+ "description": "Text for the day of the week on which the simulation starts.",
261
+ "default": "Sunday",
262
+ "enum": [
263
+ "Sunday",
264
+ "Monday",
265
+ "Tuesday",
266
+ "Wednesday",
267
+ "Thursday",
268
+ "Friday",
269
+ "Saturday"
270
+ ],
271
+ "type": "string"
272
+ },
273
+ "holidays": {
274
+ "title": "Holidays",
275
+ "description": "A list of lists where each sub-list consists of two integers for [month, day], representing a date which is a holiday within the simulation. If None, no holidays are applied.",
276
+ "minItems": 2,
277
+ "maxItems": 2,
278
+ "type": "array",
279
+ "items": {
280
+ "type": "array",
281
+ "items": {
282
+ "type": "integer",
283
+ "format": "int32"
284
+ },
285
+ "minItems": 2,
286
+ "maxItems": 2
287
+ }
288
+ },
289
+ "daylight_saving_time": {
290
+ "title": "Daylight Saving Time",
291
+ "description": "A DaylightSavingTime to dictate the start and end dates of daylight saving time. If None, no daylight saving time is applied to the simulation.",
292
+ "allOf": [
293
+ {
294
+ "$ref": "#/components/schemas/DaylightSavingTime"
295
+ }
296
+ ]
297
+ },
298
+ "leap_year": {
299
+ "title": "Leap Year",
300
+ "description": "Boolean noting whether the simulation will be run for a leap year.",
301
+ "default": false,
302
+ "type": "boolean"
303
+ }
304
+ },
305
+ "additionalProperties": false
306
+ },
307
+ "SimulationControl": {
308
+ "title": "SimulationControl",
309
+ "description": "Used to specify which types of calculations to run.",
310
+ "type": "object",
311
+ "properties": {
312
+ "type": {
313
+ "title": "Type",
314
+ "default": "SimulationControl",
315
+ "pattern": "^SimulationControl$",
316
+ "type": "string",
317
+ "readOnly": true
318
+ },
319
+ "do_zone_sizing": {
320
+ "title": "Do Zone Sizing",
321
+ "description": "Boolean for whether the zone sizing calculation should be run.",
322
+ "default": true,
323
+ "type": "boolean"
324
+ },
325
+ "do_system_sizing": {
326
+ "title": "Do System Sizing",
327
+ "description": "Boolean for whether the system sizing calculation should be run.",
328
+ "default": true,
329
+ "type": "boolean"
330
+ },
331
+ "do_plant_sizing": {
332
+ "title": "Do Plant Sizing",
333
+ "description": "Boolean for whether the plant sizing calculation should be run.",
334
+ "default": true,
335
+ "type": "boolean"
336
+ },
337
+ "run_for_run_periods": {
338
+ "title": "Run For Run Periods",
339
+ "description": "Boolean for whether the simulation should be run for the sizing periods.",
340
+ "default": true,
341
+ "type": "boolean"
342
+ },
343
+ "run_for_sizing_periods": {
344
+ "title": "Run For Sizing Periods",
345
+ "description": "Boolean for whether the simulation should be run for the run periods.",
346
+ "default": false,
347
+ "type": "boolean"
348
+ }
349
+ },
350
+ "additionalProperties": false
351
+ },
352
+ "ShadowCalculation": {
353
+ "title": "ShadowCalculation",
354
+ "description": "Used to describe settings for EnergyPlus shadow calculation.",
355
+ "type": "object",
356
+ "properties": {
357
+ "type": {
358
+ "title": "Type",
359
+ "default": "ShadowCalculation",
360
+ "pattern": "^ShadowCalculation$",
361
+ "type": "string",
362
+ "readOnly": true
363
+ },
364
+ "solar_distribution": {
365
+ "title": "Solar Distribution",
366
+ "default": "FullExteriorWithReflections",
367
+ "enum": [
368
+ "MinimalShadowing",
369
+ "FullExterior",
370
+ "FullInteriorAndExterior",
371
+ "FullExteriorWithReflections",
372
+ "FullInteriorAndExteriorWithReflections"
373
+ ],
374
+ "type": "string"
375
+ },
376
+ "calculation_frequency": {
377
+ "title": "Calculation Frequency",
378
+ "description": "Integer for the number of days in each period for which a unique shadow calculation will be performed. This field is only used if the AverageOverDaysInFrequency calculation_method is used.",
379
+ "default": 30,
380
+ "minimum": 1,
381
+ "type": "integer",
382
+ "format": "int32"
383
+ },
384
+ "calculation_method": {
385
+ "title": "Calculation Method",
386
+ "default": "AverageOverDaysInFrequency",
387
+ "enum": [
388
+ "AverageOverDaysInFrequency",
389
+ "TimestepFrequency"
390
+ ],
391
+ "type": "string"
392
+ },
393
+ "maximum_figures": {
394
+ "title": "Maximum Figures",
395
+ "description": "Number of allowable figures in shadow overlap calculations.",
396
+ "default": 15000,
397
+ "minimum": 200,
398
+ "type": "integer",
399
+ "format": "int32"
400
+ }
401
+ },
402
+ "additionalProperties": false
403
+ },
404
+ "DryBulbCondition": {
405
+ "title": "DryBulbCondition",
406
+ "description": "Used to specify dry bulb conditions on a design day.",
407
+ "type": "object",
408
+ "properties": {
409
+ "dry_bulb_max": {
410
+ "title": "Dry Bulb Max",
411
+ "description": "The maximum dry bulb temperature on the design day [C].",
412
+ "minimum": -90,
413
+ "maximum": 70,
414
+ "type": "number",
415
+ "format": "double"
416
+ },
417
+ "dry_bulb_range": {
418
+ "title": "Dry Bulb Range",
419
+ "description": "The difference between min and max temperatures on thedesign day [C].",
420
+ "minimum": 0,
421
+ "type": "number",
422
+ "format": "double"
423
+ },
424
+ "type": {
425
+ "title": "Type",
426
+ "default": "DryBulbCondition",
427
+ "pattern": "^DryBulbCondition$",
428
+ "type": "string",
429
+ "readOnly": true
430
+ }
431
+ },
432
+ "required": [
433
+ "dry_bulb_max",
434
+ "dry_bulb_range"
435
+ ],
436
+ "additionalProperties": false
437
+ },
438
+ "HumidityCondition": {
439
+ "title": "HumidityCondition",
440
+ "description": "Used to specify humidity conditions on a design day.",
441
+ "type": "object",
442
+ "properties": {
443
+ "humidity_type": {
444
+ "title": "Humidity Type",
445
+ "enum": [
446
+ "Wetbulb",
447
+ "Dewpoint",
448
+ "HumidityRatio",
449
+ "Enthalpy"
450
+ ],
451
+ "type": "string"
452
+ },
453
+ "humidity_value": {
454
+ "title": "Humidity Value",
455
+ "description": "The value correcponding to the humidity_type.",
456
+ "type": "number",
457
+ "format": "double"
458
+ },
459
+ "type": {
460
+ "title": "Type",
461
+ "default": "HumidityCondition",
462
+ "pattern": "^HumidityCondition$",
463
+ "type": "string",
464
+ "readOnly": true
465
+ },
466
+ "barometric_pressure": {
467
+ "title": "Barometric Pressure",
468
+ "description": "Barometric air pressure on the design day [Pa].",
469
+ "default": 101325,
470
+ "minimum": 31000,
471
+ "maximum": 120000,
472
+ "type": "number",
473
+ "format": "double"
474
+ },
475
+ "rain": {
476
+ "title": "Rain",
477
+ "description": "Boolean to indicate rain on the design day.",
478
+ "default": false,
479
+ "type": "boolean"
480
+ },
481
+ "snow_on_ground": {
482
+ "title": "Snow On Ground",
483
+ "description": "Boolean to indicate snow on the ground during the design day.",
484
+ "default": false,
485
+ "type": "boolean"
486
+ }
487
+ },
488
+ "required": [
489
+ "humidity_type",
490
+ "humidity_value"
491
+ ],
492
+ "additionalProperties": false
493
+ },
494
+ "WindCondition": {
495
+ "title": "WindCondition",
496
+ "description": "Used to specify wind conditions on a design day.",
497
+ "type": "object",
498
+ "properties": {
499
+ "wind_speed": {
500
+ "title": "Wind Speed",
501
+ "description": "Wind speed on the design day [m/s].",
502
+ "minimum": 0,
503
+ "maximum": 40,
504
+ "type": "number",
505
+ "format": "double"
506
+ },
507
+ "type": {
508
+ "title": "Type",
509
+ "default": "WindCondition",
510
+ "pattern": "^WindCondition$",
511
+ "type": "string",
512
+ "readOnly": true
513
+ },
514
+ "wind_direction": {
515
+ "title": "Wind Direction",
516
+ "description": "Wind direction on the design day [degrees].",
517
+ "default": 0,
518
+ "minimum": 0,
519
+ "maximum": 360,
520
+ "type": "number",
521
+ "format": "double"
522
+ }
523
+ },
524
+ "required": [
525
+ "wind_speed"
526
+ ],
527
+ "additionalProperties": false
528
+ },
529
+ "ASHRAEClearSky": {
530
+ "title": "ASHRAEClearSky",
531
+ "description": "Used to specify sky conditions on a design day.",
532
+ "type": "object",
533
+ "properties": {
534
+ "date": {
535
+ "title": "Date",
536
+ "description": "A list of two integers for [month, day], representing the date for the day of the year on which the design day occurs.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
537
+ "type": "array",
538
+ "items": {
539
+ "type": "integer",
540
+ "format": "int32"
541
+ },
542
+ "minItems": 2,
543
+ "maxItems": 3
544
+ },
545
+ "clearness": {
546
+ "title": "Clearness",
547
+ "description": "Value between 0 and 1.2 that will get multiplied by the irradinace to correct for factors like elevation above sea level.",
548
+ "minimum": 0,
549
+ "maximum": 1.2,
550
+ "type": "number",
551
+ "format": "double"
552
+ },
553
+ "daylight_savings": {
554
+ "title": "Daylight Savings",
555
+ "description": "Boolean to indicate whether daylight savings time is active on the design day.",
556
+ "default": false,
557
+ "type": "boolean"
558
+ },
559
+ "type": {
560
+ "title": "Type",
561
+ "default": "ASHRAEClearSky",
562
+ "pattern": "^ASHRAEClearSky$",
563
+ "type": "string",
564
+ "readOnly": true
565
+ }
566
+ },
567
+ "required": [
568
+ "date",
569
+ "clearness"
570
+ ],
571
+ "additionalProperties": false
572
+ },
573
+ "ASHRAETau": {
574
+ "title": "ASHRAETau",
575
+ "description": "Used to specify sky conditions on a design day.",
576
+ "type": "object",
577
+ "properties": {
578
+ "date": {
579
+ "title": "Date",
580
+ "description": "A list of two integers for [month, day], representing the date for the day of the year on which the design day occurs.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
581
+ "type": "array",
582
+ "items": {
583
+ "type": "integer",
584
+ "format": "int32"
585
+ },
586
+ "minItems": 2,
587
+ "maxItems": 3
588
+ },
589
+ "tau_b": {
590
+ "title": "Tau B",
591
+ "description": "Value for the beam optical depth. Typically found in .stat files.",
592
+ "minimum": 0,
593
+ "maximum": 1.2,
594
+ "type": "number",
595
+ "format": "double"
596
+ },
597
+ "tau_d": {
598
+ "title": "Tau D",
599
+ "description": "Value for the diffuse optical depth. Typically found in .stat files.",
600
+ "minimum": 0,
601
+ "maximum": 3,
602
+ "type": "number",
603
+ "format": "double"
604
+ },
605
+ "daylight_savings": {
606
+ "title": "Daylight Savings",
607
+ "description": "Boolean to indicate whether daylight savings time is active on the design day.",
608
+ "default": false,
609
+ "type": "boolean"
610
+ },
611
+ "type": {
612
+ "title": "Type",
613
+ "default": "ASHRAETau",
614
+ "pattern": "^ASHRAETau$",
615
+ "type": "string",
616
+ "readOnly": true
617
+ }
618
+ },
619
+ "required": [
620
+ "date",
621
+ "tau_b",
622
+ "tau_d"
623
+ ],
624
+ "additionalProperties": false
625
+ },
626
+ "DesignDay": {
627
+ "title": "DesignDay",
628
+ "description": "An object representing design day conditions.",
629
+ "type": "object",
630
+ "properties": {
631
+ "name": {
632
+ "title": "Name",
633
+ "description": "Text string for a unique design day name. This name remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). It is also used to reference the object within SimulationParameters. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
634
+ "maxLength": 100,
635
+ "minLength": 1,
636
+ "type": "string"
637
+ },
638
+ "day_type": {
639
+ "title": "Day Type",
640
+ "enum": [
641
+ "SummerDesignDay",
642
+ "WinterDesignDay",
643
+ "Sunday",
644
+ "Monday",
645
+ "Tuesday",
646
+ "Wednesday",
647
+ "Thursday",
648
+ "Friday",
649
+ "Holiday",
650
+ "CustomDay1",
651
+ "CustomDay2"
652
+ ],
653
+ "type": "string"
654
+ },
655
+ "dry_bulb_condition": {
656
+ "title": "Dry Bulb Condition",
657
+ "description": "A DryBulbCondition describing temperature conditions on the design day.",
658
+ "allOf": [
659
+ {
660
+ "$ref": "#/components/schemas/DryBulbCondition"
661
+ }
662
+ ]
663
+ },
664
+ "humidity_condition": {
665
+ "title": "Humidity Condition",
666
+ "description": "A HumidityCondition describing humidity and precipitation conditions on the design day.",
667
+ "allOf": [
668
+ {
669
+ "$ref": "#/components/schemas/HumidityCondition"
670
+ }
671
+ ]
672
+ },
673
+ "wind_condition": {
674
+ "title": "Wind Condition",
675
+ "description": "A WindCondition describing wind conditions on the design day.",
676
+ "allOf": [
677
+ {
678
+ "$ref": "#/components/schemas/WindCondition"
679
+ }
680
+ ]
681
+ },
682
+ "sky_condition": {
683
+ "title": "Sky Condition",
684
+ "anyOf": [
685
+ {
686
+ "$ref": "#/components/schemas/ASHRAEClearSky"
687
+ },
688
+ {
689
+ "$ref": "#/components/schemas/ASHRAETau"
690
+ }
691
+ ]
692
+ },
693
+ "type": {
694
+ "title": "Type",
695
+ "default": "DesignDay",
696
+ "pattern": "^DesignDay$",
697
+ "type": "string",
698
+ "readOnly": true
699
+ }
700
+ },
701
+ "required": [
702
+ "name",
703
+ "day_type",
704
+ "dry_bulb_condition",
705
+ "humidity_condition",
706
+ "wind_condition",
707
+ "sky_condition"
708
+ ],
709
+ "additionalProperties": false
710
+ },
711
+ "SizingParameter": {
712
+ "title": "SizingParameter",
713
+ "description": "Used to specify heating and cooling sizing criteria and safety factors.",
714
+ "type": "object",
715
+ "properties": {
716
+ "type": {
717
+ "title": "Type",
718
+ "default": "SizingParameter",
719
+ "pattern": "^SizingParameter$",
720
+ "type": "string",
721
+ "readOnly": true
722
+ },
723
+ "design_days": {
724
+ "title": "Design Days",
725
+ "description": "A list of DesignDays that represent the criteria for which the HVAC systems will be sized.",
726
+ "type": "array",
727
+ "items": {
728
+ "$ref": "#/components/schemas/DesignDay"
729
+ }
730
+ },
731
+ "heating_factor": {
732
+ "title": "Heating Factor",
733
+ "description": "A number that will be multiplied by the peak heating load for each zone in order to size the heating system.",
734
+ "default": 1.25,
735
+ "exclusiveMinimum": 0,
736
+ "type": "number",
737
+ "format": "double"
738
+ },
739
+ "cooling_factor": {
740
+ "title": "Cooling Factor",
741
+ "description": "A number that will be multiplied by the peak cooling load for each zone in order to size the heating system.",
742
+ "default": 1.15,
743
+ "exclusiveMinimum": 0,
744
+ "type": "number",
745
+ "format": "double"
746
+ }
747
+ },
748
+ "additionalProperties": false
749
+ },
750
+ "SimulationParameter": {
751
+ "title": "SimulationParameter",
752
+ "description": "The complete set of EnergyPlus Simulation Settings.",
753
+ "type": "object",
754
+ "properties": {
755
+ "type": {
756
+ "title": "Type",
757
+ "default": "SimulationParameter",
758
+ "pattern": "^SimulationParameter$",
759
+ "type": "string",
760
+ "readOnly": true
761
+ },
762
+ "output": {
763
+ "title": "Output",
764
+ "description": "A SimulationOutput that lists the desired outputs from the simulation and the format in which to report them.",
765
+ "allOf": [
766
+ {
767
+ "$ref": "#/components/schemas/SimulationOutput"
768
+ }
769
+ ]
770
+ },
771
+ "run_period": {
772
+ "title": "Run Period",
773
+ "description": "A RunPeriod to describe the time period over which to run the simulation.",
774
+ "allOf": [
775
+ {
776
+ "$ref": "#/components/schemas/RunPeriod"
777
+ }
778
+ ]
779
+ },
780
+ "timestep": {
781
+ "title": "Timestep",
782
+ "description": "An integer for the number of timesteps per hour at which the energy calculation will be run.",
783
+ "default": 6,
784
+ "minimum": 1,
785
+ "maximum": 60,
786
+ "type": "integer",
787
+ "format": "int32"
788
+ },
789
+ "simulation_control": {
790
+ "title": "Simulation Control",
791
+ "description": "A SimulationControl object that describes which types of calculations to run.",
792
+ "allOf": [
793
+ {
794
+ "$ref": "#/components/schemas/SimulationControl"
795
+ }
796
+ ]
797
+ },
798
+ "shadow_calculation": {
799
+ "title": "Shadow Calculation",
800
+ "description": "A ShadowCalculation object describing settings for the EnergyPlus Shadow Calculation.",
801
+ "allOf": [
802
+ {
803
+ "$ref": "#/components/schemas/ShadowCalculation"
804
+ }
805
+ ]
806
+ },
807
+ "sizing_parameter": {
808
+ "title": "Sizing Parameter",
809
+ "description": "A SizingParameter object with criteria for sizing the heating and cooling system.",
810
+ "allOf": [
811
+ {
812
+ "$ref": "#/components/schemas/SizingParameter"
813
+ }
814
+ ]
815
+ },
816
+ "north_angle": {
817
+ "title": "North Angle",
818
+ "description": "A number between -360 and 360 for the north direction in degrees.This is the counterclockwise difference between the North and the positive Y-axis. 90 is West and 270 is East. Note that this is different than the convention used in EnergyPlus, which uses clockwise difference instead of counterclockwise difference.",
819
+ "default": 0,
820
+ "exclusiveMaximum": 360,
821
+ "minimum": -360,
822
+ "type": "number",
823
+ "format": "double"
824
+ },
825
+ "terrain_type": {
826
+ "title": "Terrain Type",
827
+ "description": "Text for the terrain in which the model sits. This is used to determine the wind profile over the height of the rooms.",
828
+ "default": "City",
829
+ "enum": [
830
+ "Ocean",
831
+ "Country",
832
+ "Suburbs",
833
+ "Urban",
834
+ "City"
835
+ ],
836
+ "type": "string"
837
+ }
838
+ },
839
+ "additionalProperties": false
840
+ }
841
+ }
842
+ }
973
843
  }