honeybee-openstudio 2.4.0 → 2.6.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 35541c0e7f21c2cf1d8036b1b5f845a458504ec2a9203683b18d64970c47894e
4
- data.tar.gz: f4cf4ecb4c33a1b4a36192fa286ff21044276db7b33ee014894877425e3b877a
3
+ metadata.gz: c28727c336caac62e6fe1758d4bdcb3c7440a8f6da5bedf777094d4786926ba7
4
+ data.tar.gz: 8d111e901b300df779ed35574b98e5c4d82231ba50ba398f1f88fb3b61d2016a
5
5
  SHA512:
6
- metadata.gz: 8081aaf32d35c671f50d59cd1515f2ff8c0b8e3f583ec1ebcaef1107507f1acf569c6db35afe5a53a5f928314a4c8cdb9dde3c08016d61f31353073ae904eb36
7
- data.tar.gz: d45a7b5b22848894e87d4c6cb8b5d8d043b23b3ed71cb2c218b1411949eb066e805736edffb6f6b750a63f871965d459cf5a5e2cefa4c0e52a5c9a0d6b8065d4
6
+ metadata.gz: 40be5068a614f6c171eca8465381692d5273035688e047cecd4f14a2115d5f8a0f2ee356944383b854bdcf4af9e12955b1dd83831ec2f4a5e7971d49d4ddf8c8
7
+ data.tar.gz: c7273c379fc78675073e4bbd482b903cbad150624ff908fdb2da96bd7b5961277a1350a5d74c9f0aacd51f029657680377b7e93363fec835903cd3639623a41b
@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
4
 
5
5
  Gem::Specification.new do |spec|
6
6
  spec.name = 'honeybee-openstudio'
7
- spec.version = '2.4.0'
7
+ spec.version = '2.6.0'
8
8
  spec.authors = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
9
9
  spec.email = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
10
10
 
@@ -21,4 +21,4 @@ else
21
21
  end
22
22
 
23
23
  # include the honeybee-openstudio-gem
24
- gem 'honeybee-openstudio', '2.3.0'
24
+ gem 'honeybee-openstudio', '2.5.3'
@@ -3,7 +3,7 @@
3
3
  "servers": [],
4
4
  "info": {
5
5
  "description": "This is the documentation for Honeybee model schema.",
6
- "version": "1.34.3",
6
+ "version": "1.36.0",
7
7
  "title": "Honeybee Model Schema",
8
8
  "contact": {
9
9
  "name": "Ladybug Tools",
@@ -24,6 +24,11 @@
24
24
  "url": "./model_inheritance.json"
25
25
  },
26
26
  "tags": [
27
+ {
28
+ "name": "afncrack_model",
29
+ "x-displayName": "AFNCrack",
30
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AFNCrack\" />\n"
31
+ },
27
32
  {
28
33
  "name": "adiabatic_model",
29
34
  "x-displayName": "Adiabatic",
@@ -39,6 +44,11 @@
39
44
  "x-displayName": "AirBoundaryConstructionAbridged",
40
45
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AirBoundaryConstructionAbridged\" />\n"
41
46
  },
47
+ {
48
+ "name": "allaireconomizertype_model",
49
+ "x-displayName": "AllAirEconomizerType",
50
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AllAirEconomizerType\" />\n"
51
+ },
42
52
  {
43
53
  "name": "aperture_model",
44
54
  "x-displayName": "Aperture",
@@ -94,6 +104,26 @@
94
104
  "x-displayName": "BSDF",
95
105
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BSDF\" />\n"
96
106
  },
107
+ {
108
+ "name": "baseboard_model",
109
+ "x-displayName": "Baseboard",
110
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Baseboard\" />\n"
111
+ },
112
+ {
113
+ "name": "baseboardequipmenttype_model",
114
+ "x-displayName": "BaseboardEquipmentType",
115
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BaseboardEquipmentType\" />\n"
116
+ },
117
+ {
118
+ "name": "buildingtype_model",
119
+ "x-displayName": "BuildingType",
120
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BuildingType\" />\n"
121
+ },
122
+ {
123
+ "name": "color_model",
124
+ "x-displayName": "Color",
125
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Color\" />\n"
126
+ },
97
127
  {
98
128
  "name": "constructionset_model",
99
129
  "x-displayName": "ConstructionSet",
@@ -104,6 +134,11 @@
104
134
  "x-displayName": "ConstructionSetAbridged",
105
135
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ConstructionSetAbridged\" />\n"
106
136
  },
137
+ {
138
+ "name": "controltype_model",
139
+ "x-displayName": "ControlType",
140
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ControlType\" />\n"
141
+ },
107
142
  {
108
143
  "name": "door_model",
109
144
  "x-displayName": "Door",
@@ -144,6 +179,11 @@
144
179
  "x-displayName": "DoorRadiancePropertiesAbridged",
145
180
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DoorRadiancePropertiesAbridged\" />\n"
146
181
  },
182
+ {
183
+ "name": "economizertype_model",
184
+ "x-displayName": "EconomizerType",
185
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EconomizerType\" />\n"
186
+ },
147
187
  {
148
188
  "name": "electricequipment_model",
149
189
  "x-displayName": "ElectricEquipment",
@@ -159,11 +199,6 @@
159
199
  "x-displayName": "EnergyMaterial",
160
200
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EnergyMaterial\" />\n"
161
201
  },
162
- {
163
- "name": "roughness_model",
164
- "x-displayName": "Roughness",
165
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Roughness\" />\n"
166
- },
167
202
  {
168
203
  "name": "energymaterialnomass_model",
169
204
  "x-displayName": "EnergyMaterialNoMass",
@@ -174,21 +209,11 @@
174
209
  "x-displayName": "EnergyWindowMaterialBlind",
175
210
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EnergyWindowMaterialBlind\" />\n"
176
211
  },
177
- {
178
- "name": "slatorientation_model",
179
- "x-displayName": "SlatOrientation",
180
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SlatOrientation\" />\n"
181
- },
182
212
  {
183
213
  "name": "energywindowmaterialgas_model",
184
214
  "x-displayName": "EnergyWindowMaterialGas",
185
215
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EnergyWindowMaterialGas\" />\n"
186
216
  },
187
- {
188
- "name": "gastype_model",
189
- "x-displayName": "GasType",
190
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/GasType\" />\n"
191
- },
192
217
  {
193
218
  "name": "energywindowmaterialgascustom_model",
194
219
  "x-displayName": "EnergyWindowMaterialGasCustom",
@@ -214,16 +239,41 @@
214
239
  "x-displayName": "EnergyWindowMaterialSimpleGlazSys",
215
240
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EnergyWindowMaterialSimpleGlazSys\" />\n"
216
241
  },
242
+ {
243
+ "name": "evaporativecooler_model",
244
+ "x-displayName": "EvaporativeCooler",
245
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaporativeCooler\" />\n"
246
+ },
247
+ {
248
+ "name": "evaporativecoolerequipmenttype_model",
249
+ "x-displayName": "EvaporativeCoolerEquipmentType",
250
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaporativeCoolerEquipmentType\" />\n"
251
+ },
252
+ {
253
+ "name": "fcu_model",
254
+ "x-displayName": "FCU",
255
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FCU\" />\n"
256
+ },
257
+ {
258
+ "name": "fcuequipmenttype_model",
259
+ "x-displayName": "FCUEquipmentType",
260
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FCUEquipmentType\" />\n"
261
+ },
262
+ {
263
+ "name": "fcuwithdoas_model",
264
+ "x-displayName": "FCUwithDOAS",
265
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FCUwithDOAS\" />\n"
266
+ },
267
+ {
268
+ "name": "fcuwithdoasequipmenttype_model",
269
+ "x-displayName": "FCUwithDOASEquipmentType",
270
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FCUwithDOASEquipmentType\" />\n"
271
+ },
217
272
  {
218
273
  "name": "face_model",
219
274
  "x-displayName": "Face",
220
275
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Face\" />\n"
221
276
  },
222
- {
223
- "name": "facetype_model",
224
- "x-displayName": "FaceType",
225
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FaceType\" />\n"
226
- },
227
277
  {
228
278
  "name": "face3d_model",
229
279
  "x-displayName": "Face3D",
@@ -244,6 +294,11 @@
244
294
  "x-displayName": "FaceRadiancePropertiesAbridged",
245
295
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FaceRadiancePropertiesAbridged\" />\n"
246
296
  },
297
+ {
298
+ "name": "facetype_model",
299
+ "x-displayName": "FaceType",
300
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FaceType\" />\n"
301
+ },
247
302
  {
248
303
  "name": "floorconstructionset_model",
249
304
  "x-displayName": "FloorConstructionSet",
@@ -264,6 +319,16 @@
264
319
  "x-displayName": "FloorModifierSetAbridged",
265
320
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FloorModifierSetAbridged\" />\n"
266
321
  },
322
+ {
323
+ "name": "forcedairfurnace_model",
324
+ "x-displayName": "ForcedAirFurnace",
325
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ForcedAirFurnace\" />\n"
326
+ },
327
+ {
328
+ "name": "furnaceequipmenttype_model",
329
+ "x-displayName": "FurnaceEquipmentType",
330
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FurnaceEquipmentType\" />\n"
331
+ },
267
332
  {
268
333
  "name": "gasequipment_model",
269
334
  "x-displayName": "GasEquipment",
@@ -274,6 +339,21 @@
274
339
  "x-displayName": "GasEquipmentAbridged",
275
340
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/GasEquipmentAbridged\" />\n"
276
341
  },
342
+ {
343
+ "name": "gastype_model",
344
+ "x-displayName": "GasType",
345
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/GasType\" />\n"
346
+ },
347
+ {
348
+ "name": "gasunitheater_model",
349
+ "x-displayName": "GasUnitHeater",
350
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/GasUnitHeater\" />\n"
351
+ },
352
+ {
353
+ "name": "gasunitheaterequipmenttype_model",
354
+ "x-displayName": "GasUnitHeaterEquipmentType",
355
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/GasUnitHeaterEquipmentType\" />\n"
356
+ },
277
357
  {
278
358
  "name": "glass_model",
279
359
  "x-displayName": "Glass",
@@ -294,11 +374,6 @@
294
374
  "x-displayName": "IdealAirSystemAbridged",
295
375
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/IdealAirSystemAbridged\" />\n"
296
376
  },
297
- {
298
- "name": "economizertype_model",
299
- "x-displayName": "EconomizerType",
300
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EconomizerType\" />\n"
301
- },
302
377
  {
303
378
  "name": "infiltration_model",
304
379
  "x-displayName": "Infiltration",
@@ -324,6 +399,11 @@
324
399
  "x-displayName": "LightingAbridged",
325
400
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LightingAbridged\" />\n"
326
401
  },
402
+ {
403
+ "name": "mesh3d_model",
404
+ "x-displayName": "Mesh3D",
405
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Mesh3D\" />\n"
406
+ },
327
407
  {
328
408
  "name": "metal_model",
329
409
  "x-displayName": "Metal",
@@ -339,11 +419,6 @@
339
419
  "x-displayName": "Model",
340
420
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Model\" />\n"
341
421
  },
342
- {
343
- "name": "units_model",
344
- "x-displayName": "Units",
345
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Units\" />\n"
346
- },
347
422
  {
348
423
  "name": "modelenergyproperties_model",
349
424
  "x-displayName": "ModelEnergyProperties",
@@ -389,6 +464,36 @@
389
464
  "x-displayName": "Outdoors",
390
465
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Outdoors\" />\n"
391
466
  },
467
+ {
468
+ "name": "psz_model",
469
+ "x-displayName": "PSZ",
470
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PSZ\" />\n"
471
+ },
472
+ {
473
+ "name": "pszequipmenttype_model",
474
+ "x-displayName": "PSZEquipmentType",
475
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PSZEquipmentType\" />\n"
476
+ },
477
+ {
478
+ "name": "ptac_model",
479
+ "x-displayName": "PTAC",
480
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PTAC\" />\n"
481
+ },
482
+ {
483
+ "name": "ptacequipmenttype_model",
484
+ "x-displayName": "PTACEquipmentType",
485
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PTACEquipmentType\" />\n"
486
+ },
487
+ {
488
+ "name": "pvav_model",
489
+ "x-displayName": "PVAV",
490
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PVAV\" />\n"
491
+ },
492
+ {
493
+ "name": "pvavequipmenttype_model",
494
+ "x-displayName": "PVAVEquipmentType",
495
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PVAVEquipmentType\" />\n"
496
+ },
392
497
  {
393
498
  "name": "people_model",
394
499
  "x-displayName": "People",
@@ -429,6 +534,16 @@
429
534
  "x-displayName": "RadianceSubFaceStateAbridged",
430
535
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RadianceSubFaceStateAbridged\" />\n"
431
536
  },
537
+ {
538
+ "name": "residential_model",
539
+ "x-displayName": "Residential",
540
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Residential\" />\n"
541
+ },
542
+ {
543
+ "name": "residentialequipmenttype_model",
544
+ "x-displayName": "ResidentialEquipmentType",
545
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ResidentialEquipmentType\" />\n"
546
+ },
432
547
  {
433
548
  "name": "roofceilingconstructionset_model",
434
549
  "x-displayName": "RoofCeilingConstructionSet",
@@ -469,6 +584,11 @@
469
584
  "x-displayName": "RoomRadiancePropertiesAbridged",
470
585
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RoomRadiancePropertiesAbridged\" />\n"
471
586
  },
587
+ {
588
+ "name": "roughness_model",
589
+ "x-displayName": "Roughness",
590
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Roughness\" />\n"
591
+ },
472
592
  {
473
593
  "name": "scheduleday_model",
474
594
  "x-displayName": "ScheduleDay",
@@ -484,6 +604,11 @@
484
604
  "x-displayName": "ScheduleFixedIntervalAbridged",
485
605
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScheduleFixedIntervalAbridged\" />\n"
486
606
  },
607
+ {
608
+ "name": "schedulenumerictype_model",
609
+ "x-displayName": "ScheduleNumericType",
610
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScheduleNumericType\" />\n"
611
+ },
487
612
  {
488
613
  "name": "scheduleruleabridged_model",
489
614
  "x-displayName": "ScheduleRuleAbridged",
@@ -504,16 +629,21 @@
504
629
  "x-displayName": "ScheduleTypeLimit",
505
630
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScheduleTypeLimit\" />\n"
506
631
  },
507
- {
508
- "name": "schedulenumerictype_model",
509
- "x-displayName": "ScheduleNumericType",
510
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScheduleNumericType\" />\n"
511
- },
512
632
  {
513
633
  "name": "scheduleunittype_model",
514
634
  "x-displayName": "ScheduleUnitType",
515
635
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScheduleUnitType\" />\n"
516
636
  },
637
+ {
638
+ "name": "sensor_model",
639
+ "x-displayName": "Sensor",
640
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Sensor\" />\n"
641
+ },
642
+ {
643
+ "name": "sensorgrid_model",
644
+ "x-displayName": "SensorGrid",
645
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SensorGrid\" />\n"
646
+ },
517
647
  {
518
648
  "name": "setpoint_model",
519
649
  "x-displayName": "Setpoint",
@@ -539,6 +669,11 @@
539
669
  "x-displayName": "ShadeEnergyPropertiesAbridged",
540
670
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadeEnergyPropertiesAbridged\" />\n"
541
671
  },
672
+ {
673
+ "name": "shadelocation_model",
674
+ "x-displayName": "ShadeLocation",
675
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadeLocation\" />\n"
676
+ },
542
677
  {
543
678
  "name": "shademodifierset_model",
544
679
  "x-displayName": "ShadeModifierSet",
@@ -559,6 +694,11 @@
559
694
  "x-displayName": "ShadeRadiancePropertiesAbridged",
560
695
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadeRadiancePropertiesAbridged\" />\n"
561
696
  },
697
+ {
698
+ "name": "slatorientation_model",
699
+ "x-displayName": "SlatOrientation",
700
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SlatOrientation\" />\n"
701
+ },
562
702
  {
563
703
  "name": "stategeometryabridged_model",
564
704
  "x-displayName": "StateGeometryAbridged",
@@ -574,6 +714,41 @@
574
714
  "x-displayName": "Trans",
575
715
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Trans\" />\n"
576
716
  },
717
+ {
718
+ "name": "units_model",
719
+ "x-displayName": "Units",
720
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Units\" />\n"
721
+ },
722
+ {
723
+ "name": "vav_model",
724
+ "x-displayName": "VAV",
725
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VAV\" />\n"
726
+ },
727
+ {
728
+ "name": "vavequipmenttype_model",
729
+ "x-displayName": "VAVEquipmentType",
730
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VAVEquipmentType\" />\n"
731
+ },
732
+ {
733
+ "name": "vrf_model",
734
+ "x-displayName": "VRF",
735
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VRF\" />\n"
736
+ },
737
+ {
738
+ "name": "vrfequipmenttype_model",
739
+ "x-displayName": "VRFEquipmentType",
740
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VRFEquipmentType\" />\n"
741
+ },
742
+ {
743
+ "name": "vrfwithdoas_model",
744
+ "x-displayName": "VRFwithDOAS",
745
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VRFwithDOAS\" />\n"
746
+ },
747
+ {
748
+ "name": "vrfwithdoasequipmenttype_model",
749
+ "x-displayName": "VRFwithDOASEquipmentType",
750
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VRFwithDOASEquipmentType\" />\n"
751
+ },
577
752
  {
578
753
  "name": "ventilation_model",
579
754
  "x-displayName": "Ventilation",
@@ -584,11 +759,66 @@
584
759
  "x-displayName": "VentilationAbridged",
585
760
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationAbridged\" />\n"
586
761
  },
762
+ {
763
+ "name": "ventilationcontrolabridged_model",
764
+ "x-displayName": "VentilationControlAbridged",
765
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationControlAbridged\" />\n"
766
+ },
767
+ {
768
+ "name": "ventilationcontroltype_model",
769
+ "x-displayName": "VentilationControlType",
770
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationControlType\" />\n"
771
+ },
772
+ {
773
+ "name": "ventilationopening_model",
774
+ "x-displayName": "VentilationOpening",
775
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationOpening\" />\n"
776
+ },
777
+ {
778
+ "name": "ventilationsimulationcontrol_model",
779
+ "x-displayName": "VentilationSimulationControl",
780
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationSimulationControl\" />\n"
781
+ },
782
+ {
783
+ "name": "view_model",
784
+ "x-displayName": "View",
785
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/View\" />\n"
786
+ },
787
+ {
788
+ "name": "viewtype_model",
789
+ "x-displayName": "ViewType",
790
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ViewType\" />\n"
791
+ },
792
+ {
793
+ "name": "vintages_model",
794
+ "x-displayName": "Vintages",
795
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Vintages\" />\n"
796
+ },
587
797
  {
588
798
  "name": "void_model",
589
799
  "x-displayName": "Void",
590
800
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Void\" />\n"
591
801
  },
802
+ {
803
+ "name": "wshp_model",
804
+ "x-displayName": "WSHP",
805
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WSHP\" />\n"
806
+ },
807
+ {
808
+ "name": "wshpequipmenttype_model",
809
+ "x-displayName": "WSHPEquipmentType",
810
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WSHPEquipmentType\" />\n"
811
+ },
812
+ {
813
+ "name": "wshpwithdoas_model",
814
+ "x-displayName": "WSHPwithDOAS",
815
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WSHPwithDOAS\" />\n"
816
+ },
817
+ {
818
+ "name": "wshpwithdoasequipmenttype_model",
819
+ "x-displayName": "WSHPwithDOASEquipmentType",
820
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WSHPwithDOASEquipmentType\" />\n"
821
+ },
592
822
  {
593
823
  "name": "wallconstructionset_model",
594
824
  "x-displayName": "WallConstructionSet",
@@ -609,6 +839,16 @@
609
839
  "x-displayName": "WallModifierSetAbridged",
610
840
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WallModifierSetAbridged\" />\n"
611
841
  },
842
+ {
843
+ "name": "windowac_model",
844
+ "x-displayName": "WindowAC",
845
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindowAC\" />\n"
846
+ },
847
+ {
848
+ "name": "windowacequipmenttype_model",
849
+ "x-displayName": "WindowACEquipmentType",
850
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindowACEquipmentType\" />\n"
851
+ },
612
852
  {
613
853
  "name": "windowconstruction_model",
614
854
  "x-displayName": "WindowConstruction",
@@ -624,16 +864,6 @@
624
864
  "x-displayName": "WindowConstructionShade",
625
865
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindowConstructionShade\" />\n"
626
866
  },
627
- {
628
- "name": "shadelocation_model",
629
- "x-displayName": "ShadeLocation",
630
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadeLocation\" />\n"
631
- },
632
- {
633
- "name": "controltype_model",
634
- "x-displayName": "ControlType",
635
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ControlType\" />\n"
636
- },
637
867
  {
638
868
  "name": "windowconstructionshadeabridged_model",
639
869
  "x-displayName": "WindowConstructionShadeAbridged",
@@ -645,8 +875,10 @@
645
875
  "name": "Models",
646
876
  "tags": [
647
877
  "adiabatic_model",
878
+ "afncrack_model",
648
879
  "airboundaryconstruction_model",
649
880
  "airboundaryconstructionabridged_model",
881
+ "allaireconomizertype_model",
650
882
  "aperture_model",
651
883
  "apertureconstructionset_model",
652
884
  "apertureconstructionsetabridged_model",
@@ -657,7 +889,11 @@
657
889
  "apertureradiancepropertiesabridged_model",
658
890
  "autocalculate_model",
659
891
  "autosize_model",
892
+ "baseboard_model",
893
+ "baseboardequipmenttype_model",
660
894
  "bsdf_model",
895
+ "buildingtype_model",
896
+ "color_model",
661
897
  "constructionset_model",
662
898
  "constructionsetabridged_model",
663
899
  "controltype_model",
@@ -681,19 +917,29 @@
681
917
  "energywindowmaterialglazing_model",
682
918
  "energywindowmaterialshade_model",
683
919
  "energywindowmaterialsimpleglazsys_model",
920
+ "evaporativecooler_model",
921
+ "evaporativecoolerequipmenttype_model",
684
922
  "face3d_model",
685
923
  "face_model",
686
924
  "faceenergypropertiesabridged_model",
687
925
  "facepropertiesabridged_model",
688
926
  "faceradiancepropertiesabridged_model",
689
927
  "facetype_model",
928
+ "fcu_model",
929
+ "fcuequipmenttype_model",
930
+ "fcuwithdoas_model",
931
+ "fcuwithdoasequipmenttype_model",
690
932
  "floorconstructionset_model",
691
933
  "floorconstructionsetabridged_model",
692
934
  "floormodifierset_model",
693
935
  "floormodifiersetabridged_model",
936
+ "forcedairfurnace_model",
937
+ "furnaceequipmenttype_model",
694
938
  "gasequipment_model",
695
939
  "gasequipmentabridged_model",
696
940
  "gastype_model",
941
+ "gasunitheater_model",
942
+ "gasunitheaterequipmenttype_model",
697
943
  "glass_model",
698
944
  "glow_model",
699
945
  "ground_model",
@@ -703,6 +949,7 @@
703
949
  "light_model",
704
950
  "lighting_model",
705
951
  "lightingabridged_model",
952
+ "mesh3d_model",
706
953
  "metal_model",
707
954
  "mirror_model",
708
955
  "model_model",
@@ -721,8 +968,16 @@
721
968
  "plastic_model",
722
969
  "programtype_model",
723
970
  "programtypeabridged_model",
971
+ "psz_model",
972
+ "pszequipmenttype_model",
973
+ "ptac_model",
974
+ "ptacequipmenttype_model",
975
+ "pvav_model",
976
+ "pvavequipmenttype_model",
724
977
  "radianceshadestateabridged_model",
725
978
  "radiancesubfacestateabridged_model",
979
+ "residential_model",
980
+ "residentialequipmenttype_model",
726
981
  "roofceilingconstructionset_model",
727
982
  "roofceilingconstructionsetabridged_model",
728
983
  "roofceilingmodifierset_model",
@@ -741,6 +996,8 @@
741
996
  "schedulerulesetabridged_model",
742
997
  "scheduletypelimit_model",
743
998
  "scheduleunittype_model",
999
+ "sensor_model",
1000
+ "sensorgrid_model",
744
1001
  "setpoint_model",
745
1002
  "setpointabridged_model",
746
1003
  "shade_model",
@@ -756,17 +1013,36 @@
756
1013
  "surface_model",
757
1014
  "trans_model",
758
1015
  "units_model",
1016
+ "vav_model",
1017
+ "vavequipmenttype_model",
759
1018
  "ventilation_model",
760
1019
  "ventilationabridged_model",
1020
+ "ventilationcontrolabridged_model",
1021
+ "ventilationcontroltype_model",
1022
+ "ventilationopening_model",
1023
+ "ventilationsimulationcontrol_model",
1024
+ "view_model",
1025
+ "viewtype_model",
1026
+ "vintages_model",
761
1027
  "void_model",
1028
+ "vrf_model",
1029
+ "vrfequipmenttype_model",
1030
+ "vrfwithdoas_model",
1031
+ "vrfwithdoasequipmenttype_model",
762
1032
  "wallconstructionset_model",
763
1033
  "wallconstructionsetabridged_model",
764
1034
  "wallmodifierset_model",
765
1035
  "wallmodifiersetabridged_model",
1036
+ "windowac_model",
1037
+ "windowacequipmenttype_model",
766
1038
  "windowconstruction_model",
767
1039
  "windowconstructionabridged_model",
768
1040
  "windowconstructionshade_model",
769
- "windowconstructionshadeabridged_model"
1041
+ "windowconstructionshadeabridged_model",
1042
+ "wshp_model",
1043
+ "wshpequipmenttype_model",
1044
+ "wshpwithdoas_model",
1045
+ "wshpwithdoasequipmenttype_model"
770
1046
  ]
771
1047
  }
772
1048
  ],
@@ -781,24 +1057,24 @@
781
1057
  "n": {
782
1058
  "title": "N",
783
1059
  "description": "Plane normal as 3 (x, y, z) values.",
1060
+ "minItems": 3,
1061
+ "maxItems": 3,
784
1062
  "type": "array",
785
1063
  "items": {
786
1064
  "type": "number",
787
1065
  "format": "double"
788
- },
789
- "minItems": 3,
790
- "maxItems": 3
1066
+ }
791
1067
  },
792
1068
  "o": {
793
1069
  "title": "O",
794
1070
  "description": "Plane origin as 3 (x, y, z) values",
1071
+ "minItems": 3,
1072
+ "maxItems": 3,
795
1073
  "type": "array",
796
1074
  "items": {
797
1075
  "type": "number",
798
1076
  "format": "double"
799
- },
800
- "minItems": 3,
801
- "maxItems": 3
1077
+ }
802
1078
  },
803
1079
  "type": {
804
1080
  "title": "Type",
@@ -810,13 +1086,13 @@
810
1086
  "x": {
811
1087
  "title": "X",
812
1088
  "description": "Plane x-axis as 3 (x, y, z) values. If None, it is autocalculated.",
1089
+ "minItems": 3,
1090
+ "maxItems": 3,
813
1091
  "type": "array",
814
1092
  "items": {
815
1093
  "type": "number",
816
1094
  "format": "double"
817
- },
818
- "minItems": 3,
819
- "maxItems": 3
1095
+ }
820
1096
  }
821
1097
  },
822
1098
  "required": [
@@ -834,7 +1110,6 @@
834
1110
  "title": "Boundary",
835
1111
  "description": "A list of points representing the outer boundary vertices of the face. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.",
836
1112
  "minItems": 3,
837
- "maxItems": 3,
838
1113
  "type": "array",
839
1114
  "items": {
840
1115
  "type": "array",
@@ -856,7 +1131,6 @@
856
1131
  "holes": {
857
1132
  "title": "Holes",
858
1133
  "description": "Optional list of lists with one list for each hole in the face.Each hole should be a list of at least 3 points and each point a list of 3 (x, y, z) values. If None, it will be assumed that there are no holes in the face.",
859
- "minItems": 3,
860
1134
  "type": "array",
861
1135
  "items": {
862
1136
  "type": "array",
@@ -887,6 +1161,17 @@
887
1161
  ],
888
1162
  "additionalProperties": false
889
1163
  },
1164
+ "FaceType": {
1165
+ "title": "FaceType",
1166
+ "description": "An enumeration.",
1167
+ "enum": [
1168
+ "Wall",
1169
+ "Floor",
1170
+ "RoofCeiling",
1171
+ "AirBoundary"
1172
+ ],
1173
+ "type": "string"
1174
+ },
890
1175
  "Ground": {
891
1176
  "title": "Ground",
892
1177
  "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
@@ -985,12 +1270,12 @@
985
1270
  "boundary_condition_objects": {
986
1271
  "title": "Boundary Condition Objects",
987
1272
  "description": "A list of up to 3 object identifiers that are adjacent to this one. The first object is always the one that is immediately adjacent and is of the same object type (Face, Aperture, Door). When this boundary condition is applied to a Face, the second object in the tuple will be the parent Room of the adjacent object. When the boundary condition is applied to a sub-face (Door or Aperture), the second object will be the parent Face of the adjacent sub-face and the third object will be the parent Room of the adjacent sub-face.",
1273
+ "minItems": 2,
1274
+ "maxItems": 3,
988
1275
  "type": "array",
989
1276
  "items": {
990
1277
  "type": "string"
991
- },
992
- "minItems": 2,
993
- "maxItems": 3
1278
+ }
994
1279
  },
995
1280
  "type": {
996
1281
  "title": "Type",
@@ -1228,6 +1513,78 @@
1228
1513
  ],
1229
1514
  "additionalProperties": false
1230
1515
  },
1516
+ "VentilationOpening": {
1517
+ "title": "VentilationOpening",
1518
+ "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
1519
+ "type": "object",
1520
+ "properties": {
1521
+ "type": {
1522
+ "title": "Type",
1523
+ "default": "VentilationOpening",
1524
+ "pattern": "^VentilationOpening$",
1525
+ "type": "string",
1526
+ "readOnly": true
1527
+ },
1528
+ "fraction_area_operable": {
1529
+ "title": "Fraction Area Operable",
1530
+ "description": "A number for the fraction of the window area that is operable.",
1531
+ "default": 0.5,
1532
+ "minimum": 0,
1533
+ "maximum": 1,
1534
+ "type": "number",
1535
+ "format": "double"
1536
+ },
1537
+ "fraction_height_operable": {
1538
+ "title": "Fraction Height Operable",
1539
+ "description": "A number for the fraction of the distance from the bottom of the window to the top that is operable",
1540
+ "default": 1.0,
1541
+ "minimum": 0,
1542
+ "maximum": 1,
1543
+ "type": "number",
1544
+ "format": "double"
1545
+ },
1546
+ "discharge_coefficient": {
1547
+ "title": "Discharge Coefficient",
1548
+ "description": "A number that will be multipled by the area of the window in the stack (buoyancy-driven) part of the equation to account for additional friction from window geometry, insect screens, etc. Typical values include 0.45, for unobstructed windows WITH insect screens and 0.65 for unobstructed windows WITHOUT insect screens. This value should be lowered if windows are of an awning or casement type and are not allowed to fully open.",
1549
+ "default": 0.45,
1550
+ "minimum": 0,
1551
+ "maximum": 1,
1552
+ "type": "number",
1553
+ "format": "double"
1554
+ },
1555
+ "wind_cross_vent": {
1556
+ "title": "Wind Cross Vent",
1557
+ "description": "Boolean to indicate if there is an opening of roughly equal area on the opposite side of the Room such that wind-driven cross ventilation will be induced. If False, the assumption is that the operable area is primarily on one side of the Room and there is no wind-driven ventilation.",
1558
+ "default": false,
1559
+ "type": "boolean"
1560
+ },
1561
+ "flow_coefficient_closed": {
1562
+ "title": "Flow Coefficient Closed",
1563
+ "description": "An optional number in kg/s-m, at 1 Pa per meter of crack length, used to calculate the mass flow rate when the opening is closed; required to run an AirflowNetwork simulation. The DesignBuilder Cracks template defines the flow coefficient for a tight, low-leakage closed external window to be 0.00001, and the flow coefficient for a very poor, high-leakage closed external window to be 0.003.",
1564
+ "minimum": 0,
1565
+ "type": "number",
1566
+ "format": "double"
1567
+ },
1568
+ "flow_exponent_closed": {
1569
+ "title": "Flow Exponent Closed",
1570
+ "description": "An optional dimensionless number between 0.5 and 1 used to calculate the mass flow rate when the opening is closed; required to run an AirflowNetwork simulation. This value represents the leak geometry impact on airflow, with 0.5 generally corresponding to turbulent orifice flow and 1 generally corresponding to laminar flow. The default of 0.65 is representative of many cases of wall and window leakage, used when the exponent cannot be measured.",
1571
+ "default": 0.65,
1572
+ "minimum": 0.5,
1573
+ "maximum": 1,
1574
+ "type": "number",
1575
+ "format": "double"
1576
+ },
1577
+ "two_way_threshold": {
1578
+ "title": "Two Way Threshold",
1579
+ "description": "A number in kg/m3 indicating the minimum density difference above which two-way flow may occur due to stack effect, required to run an AirflowNetwork simulation. This value is required because the air density difference between two zones (which drives two-way air flow) will tend towards division by zero errors as the air density difference approaches zero. The default of 0.0001 is a typical default value used for AirflowNetwork openings.",
1580
+ "default": 0.0001,
1581
+ "exclusiveMinimum": 0,
1582
+ "type": "number",
1583
+ "format": "double"
1584
+ }
1585
+ },
1586
+ "additionalProperties": false
1587
+ },
1231
1588
  "ApertureEnergyPropertiesAbridged": {
1232
1589
  "title": "ApertureEnergyPropertiesAbridged",
1233
1590
  "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
@@ -1246,6 +1603,15 @@
1246
1603
  "maxLength": 100,
1247
1604
  "minLength": 1,
1248
1605
  "type": "string"
1606
+ },
1607
+ "vent_opening": {
1608
+ "title": "Vent Opening",
1609
+ "description": "An optional VentilationOpening to specify the operable portion of the Aperture.",
1610
+ "allOf": [
1611
+ {
1612
+ "$ref": "#/components/schemas/VentilationOpening"
1613
+ }
1614
+ ]
1249
1615
  }
1250
1616
  },
1251
1617
  "additionalProperties": false
@@ -1466,6 +1832,15 @@
1466
1832
  "maxLength": 100,
1467
1833
  "minLength": 1,
1468
1834
  "type": "string"
1835
+ },
1836
+ "vent_opening": {
1837
+ "title": "Vent Opening",
1838
+ "description": "An optional VentilationOpening to specify the operable portion of the Door.",
1839
+ "allOf": [
1840
+ {
1841
+ "$ref": "#/components/schemas/VentilationOpening"
1842
+ }
1843
+ ]
1469
1844
  }
1470
1845
  },
1471
1846
  "additionalProperties": false
@@ -1617,6 +1992,40 @@
1617
1992
  ],
1618
1993
  "additionalProperties": false
1619
1994
  },
1995
+ "AFNCrack": {
1996
+ "title": "AFNCrack",
1997
+ "description": "Properties for airflow through a crack.",
1998
+ "type": "object",
1999
+ "properties": {
2000
+ "flow_coefficient": {
2001
+ "title": "Flow Coefficient",
2002
+ "description": "A number in kg/s-m at 1 Pa per meter of crack length at the conditions defined in the ReferenceCrack condition; required to run an AirflowNetwork simulation. The DesignBuilder Cracks template defines the flow coefficient for a tight, low-leakage wall to be 0.00001 and 0.001 for external and internal constructions, respectively. Flow coefficients for a very poor, high-leakage wall are defined to be 0.0004 and 0.019 for external and internal constructions, respectively.",
2003
+ "exclusiveMinimum": 0,
2004
+ "type": "number",
2005
+ "format": "double"
2006
+ },
2007
+ "type": {
2008
+ "title": "Type",
2009
+ "default": "AFNCrack",
2010
+ "pattern": "^AFNCrack$",
2011
+ "type": "string",
2012
+ "readOnly": true
2013
+ },
2014
+ "flow_exponent": {
2015
+ "title": "Flow Exponent",
2016
+ "description": "An optional dimensionless number between 0.5 and 1 used to calculate the crack mass flow rate; required to run an AirflowNetwork simulation. This value represents the leak geometry impact on airflow, with 0.5 generally corresponding to turbulent orifice flow and 1 generally corresponding to laminar flow. The default of 0.65 is representative of many cases of wall and window leakage, used when the exponent cannot be measured.",
2017
+ "default": 0.65,
2018
+ "minimum": 0.5,
2019
+ "maximum": 1,
2020
+ "type": "number",
2021
+ "format": "double"
2022
+ }
2023
+ },
2024
+ "required": [
2025
+ "flow_coefficient"
2026
+ ],
2027
+ "additionalProperties": false
2028
+ },
1620
2029
  "FaceEnergyPropertiesAbridged": {
1621
2030
  "title": "FaceEnergyPropertiesAbridged",
1622
2031
  "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
@@ -1635,6 +2044,15 @@
1635
2044
  "maxLength": 100,
1636
2045
  "minLength": 1,
1637
2046
  "type": "string"
2047
+ },
2048
+ "vent_crack": {
2049
+ "title": "Vent Crack",
2050
+ "description": "An optional AFNCrack to specify airflow through a surface crack used by the AirflowNetwork.",
2051
+ "allOf": [
2052
+ {
2053
+ "$ref": "#/components/schemas/AFNCrack"
2054
+ }
2055
+ ]
1638
2056
  }
1639
2057
  },
1640
2058
  "additionalProperties": false
@@ -1706,13 +2124,12 @@
1706
2124
  ]
1707
2125
  },
1708
2126
  "face_type": {
2127
+ "title": "Face Type",
1709
2128
  "allOf": [
1710
2129
  {
1711
2130
  "$ref": "#/components/schemas/FaceType"
1712
2131
  }
1713
- ],
1714
- "title": "Face Type",
1715
- "type": "string"
2132
+ ]
1716
2133
  },
1717
2134
  "boundary_condition": {
1718
2135
  "title": "Boundary Condition",
@@ -2295,6 +2712,73 @@
2295
2712
  ],
2296
2713
  "additionalProperties": false
2297
2714
  },
2715
+ "VentilationControlAbridged": {
2716
+ "title": "VentilationControlAbridged",
2717
+ "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
2718
+ "type": "object",
2719
+ "properties": {
2720
+ "type": {
2721
+ "title": "Type",
2722
+ "default": "VentilationControlAbridged",
2723
+ "pattern": "^VentilationControlAbridged$",
2724
+ "type": "string",
2725
+ "readOnly": true
2726
+ },
2727
+ "min_indoor_temperature": {
2728
+ "title": "Min Indoor Temperature",
2729
+ "description": "A number for the minimum indoor temperature at which to ventilate in Celsius. Typically, this variable is used to initiate ventilation.",
2730
+ "default": -100,
2731
+ "minimum": -100,
2732
+ "maximum": 100,
2733
+ "type": "number",
2734
+ "format": "double"
2735
+ },
2736
+ "max_indoor_temperature": {
2737
+ "title": "Max Indoor Temperature",
2738
+ "description": "A number for the maximum indoor temperature at which to ventilate in Celsius. This can be used to set a maximum temperature at which point ventilation is stopped and a cooling system is turned on.",
2739
+ "default": 100,
2740
+ "minimum": -100,
2741
+ "maximum": 100,
2742
+ "type": "number",
2743
+ "format": "double"
2744
+ },
2745
+ "min_outdoor_temperature": {
2746
+ "title": "Min Outdoor Temperature",
2747
+ "description": "A number for the minimum outdoor temperature at which to ventilate in Celsius. This can be used to ensure ventilative cooling does not happen during the winter even if the Room is above the min_indoor_temperature.",
2748
+ "default": -100,
2749
+ "minimum": -100,
2750
+ "maximum": 100,
2751
+ "type": "number",
2752
+ "format": "double"
2753
+ },
2754
+ "max_outdoor_temperature": {
2755
+ "title": "Max Outdoor Temperature",
2756
+ "description": "A number for the maximum indoor temperature at which to ventilate in Celsius. This can be used to set a limit for when it is considered too hot outside for ventilative cooling.",
2757
+ "default": 100,
2758
+ "minimum": -100,
2759
+ "maximum": 100,
2760
+ "type": "number",
2761
+ "format": "double"
2762
+ },
2763
+ "delta_temperature": {
2764
+ "title": "Delta Temperature",
2765
+ "description": "A number for the temperature differential in Celsius between indoor and outdoor below which ventilation is shut off. This should usually be a negative number so that ventilation only occurs when the outdoors is cooler than the indoors. Positive numbers indicate how much hotter the outdoors can be than the indoors before ventilation is stopped.",
2766
+ "default": -100,
2767
+ "minimum": -100,
2768
+ "maximum": 100,
2769
+ "type": "number",
2770
+ "format": "double"
2771
+ },
2772
+ "schedule": {
2773
+ "title": "Schedule",
2774
+ "description": "Identifier of the schedule for the ventilation over the course of the year. Note that this is applied on top of any setpoints. The type of this schedule should be On/Off and values should be either 0 (no possibility of ventilation) or 1 (ventilation possible).",
2775
+ "maxLength": 100,
2776
+ "minLength": 1,
2777
+ "type": "string"
2778
+ }
2779
+ },
2780
+ "additionalProperties": false
2781
+ },
2298
2782
  "RoomEnergyPropertiesAbridged": {
2299
2783
  "title": "RoomEnergyPropertiesAbridged",
2300
2784
  "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
@@ -2390,6 +2874,15 @@
2390
2874
  "$ref": "#/components/schemas/SetpointAbridged"
2391
2875
  }
2392
2876
  ]
2877
+ },
2878
+ "window_vent_control": {
2879
+ "title": "Window Vent Control",
2880
+ "description": "An optional VentilationControl object to dictate the opening of windows. If None, the windows will never open.",
2881
+ "allOf": [
2882
+ {
2883
+ "$ref": "#/components/schemas/VentilationControlAbridged"
2884
+ }
2885
+ ]
2393
2886
  }
2394
2887
  },
2395
2888
  "additionalProperties": false
@@ -2449,11 +2942,11 @@
2449
2942
  "faces": {
2450
2943
  "title": "Faces",
2451
2944
  "description": "Faces that together form the closed volume of a room.",
2945
+ "minItems": 4,
2452
2946
  "type": "array",
2453
2947
  "items": {
2454
2948
  "$ref": "#/components/schemas/Face"
2455
- },
2456
- "minItems": 4
2949
+ }
2457
2950
  },
2458
2951
  "properties": {
2459
2952
  "title": "Properties",
@@ -2521,6 +3014,18 @@
2521
3014
  ],
2522
3015
  "additionalProperties": false
2523
3016
  },
3017
+ "Units": {
3018
+ "title": "Units",
3019
+ "description": "An enumeration.",
3020
+ "enum": [
3021
+ "Meters",
3022
+ "Millimeters",
3023
+ "Feet",
3024
+ "Inches",
3025
+ "Centimeters"
3026
+ ],
3027
+ "type": "string"
3028
+ },
2524
3029
  "WallConstructionSetAbridged": {
2525
3030
  "title": "WallConstructionSetAbridged",
2526
3031
  "description": "A set of constructions for wall assemblies.",
@@ -2811,6 +3316,19 @@
2811
3316
  ],
2812
3317
  "additionalProperties": false
2813
3318
  },
3319
+ "Roughness": {
3320
+ "title": "Roughness",
3321
+ "description": "Relative roughness of a particular material layer.",
3322
+ "enum": [
3323
+ "VeryRough",
3324
+ "Rough",
3325
+ "MediumRough",
3326
+ "MediumSmooth",
3327
+ "Smooth",
3328
+ "VerySmooth"
3329
+ ],
3330
+ "type": "string"
3331
+ },
2814
3332
  "EnergyMaterial": {
2815
3333
  "title": "EnergyMaterial",
2816
3334
  "description": "Opaque material representing a layer within an opaque construction.",
@@ -2865,14 +3383,13 @@
2865
3383
  "readOnly": true
2866
3384
  },
2867
3385
  "roughness": {
3386
+ "title": "Roughness",
3387
+ "default": "MediumRough",
2868
3388
  "allOf": [
2869
3389
  {
2870
3390
  "$ref": "#/components/schemas/Roughness"
2871
3391
  }
2872
- ],
2873
- "title": "Roughness",
2874
- "default": "MediumRough",
2875
- "type": "string"
3392
+ ]
2876
3393
  },
2877
3394
  "thermal_absorptance": {
2878
3395
  "title": "Thermal Absorptance",
@@ -2943,14 +3460,13 @@
2943
3460
  "readOnly": true
2944
3461
  },
2945
3462
  "roughness": {
3463
+ "title": "Roughness",
3464
+ "default": "MediumRough",
2946
3465
  "allOf": [
2947
3466
  {
2948
3467
  "$ref": "#/components/schemas/Roughness"
2949
3468
  }
2950
- ],
2951
- "title": "Roughness",
2952
- "default": "MediumRough",
2953
- "type": "string"
3469
+ ]
2954
3470
  },
2955
3471
  "thermal_absorptance": {
2956
3472
  "title": "Thermal Absorptance",
@@ -3001,20 +3517,20 @@
3001
3517
  "layers": {
3002
3518
  "title": "Layers",
3003
3519
  "description": "List of strings for opaque material identifiers. The order of the materials is from exterior to interior.",
3004
- "minLength": 1,
3005
- "maxLength": 100,
3520
+ "minItems": 1,
3521
+ "maxItems": 10,
3006
3522
  "type": "array",
3007
3523
  "items": {
3008
3524
  "type": "string",
3009
3525
  "minLength": 1,
3010
3526
  "maxLength": 100
3011
- },
3012
- "minItems": 1,
3013
- "maxItems": 10
3527
+ }
3014
3528
  },
3015
3529
  "materials": {
3016
3530
  "title": "Materials",
3017
3531
  "description": "List of opaque materials. The order of the materials is from outside to inside.",
3532
+ "minItems": 1,
3533
+ "maxItems": 10,
3018
3534
  "type": "array",
3019
3535
  "items": {
3020
3536
  "anyOf": [
@@ -3025,9 +3541,7 @@
3025
3541
  "$ref": "#/components/schemas/EnergyMaterialNoMass"
3026
3542
  }
3027
3543
  ]
3028
- },
3029
- "minItems": 1,
3030
- "maxItems": 10
3544
+ }
3031
3545
  },
3032
3546
  "display_name": {
3033
3547
  "title": "Display Name",
@@ -3368,6 +3882,17 @@
3368
3882
  ],
3369
3883
  "additionalProperties": false
3370
3884
  },
3885
+ "GasType": {
3886
+ "title": "GasType",
3887
+ "description": "An enumeration.",
3888
+ "enum": [
3889
+ "Air",
3890
+ "Argon",
3891
+ "Krypton",
3892
+ "Xenon"
3893
+ ],
3894
+ "type": "string"
3895
+ },
3371
3896
  "EnergyWindowMaterialGas": {
3372
3897
  "title": "EnergyWindowMaterialGas",
3373
3898
  "description": "Create single layer of gas in a window construction.\n\nCan be combined with EnergyWindowMaterialGlazing to make multi-pane windows.",
@@ -3401,14 +3926,13 @@
3401
3926
  "format": "double"
3402
3927
  },
3403
3928
  "gas_type": {
3929
+ "title": "Gas Type",
3930
+ "default": "Air",
3404
3931
  "allOf": [
3405
3932
  {
3406
3933
  "$ref": "#/components/schemas/GasType"
3407
3934
  }
3408
- ],
3409
- "title": "Gas Type",
3410
- "default": "Air",
3411
- "type": "string"
3935
+ ]
3412
3936
  }
3413
3937
  },
3414
3938
  "required": [
@@ -3553,12 +4077,12 @@
3553
4077
  "description": "List of gases in the gas mixture.",
3554
4078
  "type": "array",
3555
4079
  "items": {
4080
+ "title": " Gas Types",
3556
4081
  "allOf": [
3557
4082
  {
3558
4083
  "$ref": "#/components/schemas/GasType"
3559
4084
  }
3560
- ],
3561
- "type": "string"
4085
+ ]
3562
4086
  },
3563
4087
  "minItems": 2,
3564
4088
  "maxItems": 4
@@ -3566,13 +4090,13 @@
3566
4090
  "gas_fractions": {
3567
4091
  "title": "Gas Fractions",
3568
4092
  "description": "A list of fractional numbers describing the volumetric fractions of gas types in the mixture. This list must align with the gas_types list and must sum to 1.",
4093
+ "minItems": 2,
4094
+ "maxItems": 4,
3569
4095
  "type": "array",
3570
4096
  "items": {
3571
4097
  "type": "number",
3572
4098
  "format": "double"
3573
- },
3574
- "minItems": 2,
3575
- "maxItems": 4
4099
+ }
3576
4100
  },
3577
4101
  "display_name": {
3578
4102
  "title": "Display Name",
@@ -3617,20 +4141,20 @@
3617
4141
  "layers": {
3618
4142
  "title": "Layers",
3619
4143
  "description": "List of strings for glazing or gas material identifiers. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
3620
- "minLength": 1,
3621
- "maxLength": 100,
4144
+ "minItems": 1,
4145
+ "maxItems": 8,
3622
4146
  "type": "array",
3623
4147
  "items": {
3624
4148
  "type": "string",
3625
4149
  "minLength": 1,
3626
4150
  "maxLength": 100
3627
- },
3628
- "minItems": 1,
3629
- "maxItems": 8
4151
+ }
3630
4152
  },
3631
4153
  "materials": {
3632
4154
  "title": "Materials",
3633
4155
  "description": "List of glazing and gas materials. The order of the materials is from outside to inside. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
4156
+ "minItems": 1,
4157
+ "maxItems": 8,
3634
4158
  "type": "array",
3635
4159
  "items": {
3636
4160
  "anyOf": [
@@ -3650,9 +4174,7 @@
3650
4174
  "$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
3651
4175
  }
3652
4176
  ]
3653
- },
3654
- "minItems": 1,
3655
- "maxItems": 8
4177
+ }
3656
4178
  },
3657
4179
  "display_name": {
3658
4180
  "title": "Display Name",
@@ -3879,8 +4401,6 @@
3879
4401
  0,
3880
4402
  0
3881
4403
  ],
3882
- "minItems": 2,
3883
- "maxItems": 2,
3884
4404
  "type": "array",
3885
4405
  "items": {
3886
4406
  "type": "array",
@@ -3973,13 +4493,13 @@
3973
4493
  1,
3974
4494
  1
3975
4495
  ],
4496
+ "minItems": 2,
4497
+ "maxItems": 3,
3976
4498
  "type": "array",
3977
4499
  "items": {
3978
4500
  "type": "integer",
3979
4501
  "format": "int32"
3980
- },
3981
- "minItems": 2,
3982
- "maxItems": 3
4502
+ }
3983
4503
  },
3984
4504
  "end_date": {
3985
4505
  "title": "End Date",
@@ -3988,13 +4508,13 @@
3988
4508
  12,
3989
4509
  31
3990
4510
  ],
4511
+ "minItems": 2,
4512
+ "maxItems": 3,
3991
4513
  "type": "array",
3992
4514
  "items": {
3993
4515
  "type": "integer",
3994
4516
  "format": "int32"
3995
- },
3996
- "minItems": 2,
3997
- "maxItems": 3
4517
+ }
3998
4518
  }
3999
4519
  },
4000
4520
  "required": [
@@ -4017,6 +4537,36 @@
4017
4537
  },
4018
4538
  "additionalProperties": false
4019
4539
  },
4540
+ "ScheduleNumericType": {
4541
+ "title": "ScheduleNumericType",
4542
+ "description": "Designates how the range values are validated.",
4543
+ "enum": [
4544
+ "Continuous",
4545
+ "Discrete"
4546
+ ],
4547
+ "type": "string"
4548
+ },
4549
+ "ScheduleUnitType": {
4550
+ "title": "ScheduleUnitType",
4551
+ "description": "An enumeration.",
4552
+ "enum": [
4553
+ "Dimensionless",
4554
+ "Temperature",
4555
+ "DeltaTemperature",
4556
+ "PrecipitationRate",
4557
+ "Angle",
4558
+ "ConvectionCoefficient",
4559
+ "ActivityLevel",
4560
+ "Velocity",
4561
+ "Capacity",
4562
+ "Power",
4563
+ "Availability",
4564
+ "Percent",
4565
+ "Control",
4566
+ "Mode"
4567
+ ],
4568
+ "type": "string"
4569
+ },
4020
4570
  "ScheduleTypeLimit": {
4021
4571
  "title": "ScheduleTypeLimit",
4022
4572
  "description": "Specifies the data types and limits for values contained in schedules.",
@@ -4074,24 +4624,22 @@
4074
4624
  ]
4075
4625
  },
4076
4626
  "numeric_type": {
4627
+ "title": "Numeric Type",
4628
+ "default": "Continuous",
4077
4629
  "allOf": [
4078
4630
  {
4079
4631
  "$ref": "#/components/schemas/ScheduleNumericType"
4080
4632
  }
4081
- ],
4082
- "title": "Numeric Type",
4083
- "default": "Continuous",
4084
- "type": "string"
4633
+ ]
4085
4634
  },
4086
4635
  "unit_type": {
4636
+ "title": "Unit Type",
4637
+ "default": "Dimensionless",
4087
4638
  "allOf": [
4088
4639
  {
4089
4640
  "$ref": "#/components/schemas/ScheduleUnitType"
4090
4641
  }
4091
- ],
4092
- "title": "Unit Type",
4093
- "default": "Dimensionless",
4094
- "type": "string"
4642
+ ]
4095
4643
  }
4096
4644
  },
4097
4645
  "required": [
@@ -4199,13 +4747,13 @@
4199
4747
  "values": {
4200
4748
  "title": "Values",
4201
4749
  "description": "A list of timeseries values occuring at each timestep over the course of the simulation.",
4750
+ "minItems": 24,
4751
+ "maxItems": 527040,
4202
4752
  "type": "array",
4203
4753
  "items": {
4204
4754
  "type": "number",
4205
4755
  "format": "double"
4206
- },
4207
- "minItems": 24,
4208
- "maxItems": 527040
4756
+ }
4209
4757
  },
4210
4758
  "display_name": {
4211
4759
  "title": "Display Name",
@@ -4242,13 +4790,13 @@
4242
4790
  1,
4243
4791
  1
4244
4792
  ],
4793
+ "minItems": 2,
4794
+ "maxItems": 3,
4245
4795
  "type": "array",
4246
4796
  "items": {
4247
4797
  "type": "integer",
4248
4798
  "format": "int32"
4249
- },
4250
- "minItems": 2,
4251
- "maxItems": 3
4799
+ }
4252
4800
  },
4253
4801
  "placeholder_value": {
4254
4802
  "title": "Placeholder Value",
@@ -4429,16 +4977,14 @@
4429
4977
  "layers": {
4430
4978
  "title": "Layers",
4431
4979
  "description": "List of strings for opaque material identifiers. The order of the materials is from exterior to interior.",
4432
- "minLength": 1,
4433
- "maxLength": 100,
4980
+ "minItems": 1,
4981
+ "maxItems": 10,
4434
4982
  "type": "array",
4435
4983
  "items": {
4436
4984
  "type": "string",
4437
4985
  "minLength": 1,
4438
4986
  "maxLength": 100
4439
- },
4440
- "minItems": 1,
4441
- "maxItems": 10
4987
+ }
4442
4988
  },
4443
4989
  "display_name": {
4444
4990
  "title": "Display Name",
@@ -4474,16 +5020,14 @@
4474
5020
  "layers": {
4475
5021
  "title": "Layers",
4476
5022
  "description": "List of strings for glazing or gas material identifiers. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
4477
- "minLength": 1,
4478
- "maxLength": 100,
5023
+ "minItems": 1,
5024
+ "maxItems": 8,
4479
5025
  "type": "array",
4480
5026
  "items": {
4481
5027
  "type": "string",
4482
5028
  "minLength": 1,
4483
5029
  "maxLength": 100
4484
- },
4485
- "minItems": 1,
4486
- "maxItems": 8
5030
+ }
4487
5031
  },
4488
5032
  "display_name": {
4489
5033
  "title": "Display Name",
@@ -4504,6 +5048,32 @@
4504
5048
  ],
4505
5049
  "additionalProperties": false
4506
5050
  },
5051
+ "ShadeLocation": {
5052
+ "title": "ShadeLocation",
5053
+ "description": "Choices for where a shade material is located in a window assembly.",
5054
+ "enum": [
5055
+ "Interior",
5056
+ "Between",
5057
+ "Exterior"
5058
+ ],
5059
+ "type": "string"
5060
+ },
5061
+ "ControlType": {
5062
+ "title": "ControlType",
5063
+ "description": "Choices for how the shading device is controlled.",
5064
+ "enum": [
5065
+ "AlwaysOn",
5066
+ "OnIfHighSolarOnWindow",
5067
+ "OnIfHighHorizontalSolar",
5068
+ "OnIfHighOutdoorAirTemperature",
5069
+ "OnIfHighZoneAirTemperature",
5070
+ "OnIfHighZoneCooling",
5071
+ "OnNightIfLowOutdoorTempAndOffDay",
5072
+ "OnNightIfLowInsideTempAndOffDay",
5073
+ "OnNightIfHeatingAndOffDay"
5074
+ ],
5075
+ "type": "string"
5076
+ },
4507
5077
  "WindowConstructionShadeAbridged": {
4508
5078
  "title": "WindowConstructionShadeAbridged",
4509
5079
  "description": "Construction for window objects with an included shade layer.",
@@ -4545,26 +5115,24 @@
4545
5115
  "readOnly": true
4546
5116
  },
4547
5117
  "shade_location": {
5118
+ "title": "Shade Location",
5119
+ "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
5120
+ "default": "Interior",
4548
5121
  "allOf": [
4549
5122
  {
4550
5123
  "$ref": "#/components/schemas/ShadeLocation"
4551
5124
  }
4552
- ],
4553
- "title": "Shade Location",
4554
- "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
4555
- "default": "Interior",
4556
- "type": "string"
5125
+ ]
4557
5126
  },
4558
5127
  "control_type": {
5128
+ "title": "Control Type",
5129
+ "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
5130
+ "default": "AlwaysOn",
4559
5131
  "allOf": [
4560
5132
  {
4561
5133
  "$ref": "#/components/schemas/ControlType"
4562
5134
  }
4563
- ],
4564
- "title": "Control Type",
4565
- "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
4566
- "default": "AlwaysOn",
4567
- "type": "string"
5135
+ ]
4568
5136
  },
4569
5137
  "setpoint": {
4570
5138
  "title": "Setpoint",
@@ -4787,6 +5355,15 @@
4787
5355
  ],
4788
5356
  "additionalProperties": false
4789
5357
  },
5358
+ "SlatOrientation": {
5359
+ "title": "SlatOrientation",
5360
+ "description": "An enumeration.",
5361
+ "enum": [
5362
+ "Horizontal",
5363
+ "Vertical"
5364
+ ],
5365
+ "type": "string"
5366
+ },
4790
5367
  "EnergyWindowMaterialBlind": {
4791
5368
  "title": "EnergyWindowMaterialBlind",
4792
5369
  "description": "Window blind material consisting of flat, equally-spaced slats.",
@@ -4812,14 +5389,13 @@
4812
5389
  "readOnly": true
4813
5390
  },
4814
5391
  "slat_orientation": {
5392
+ "title": "Slat Orientation",
5393
+ "default": "Horizontal",
4815
5394
  "allOf": [
4816
5395
  {
4817
5396
  "$ref": "#/components/schemas/SlatOrientation"
4818
5397
  }
4819
- ],
4820
- "title": "Slat Orientation",
4821
- "default": "Horizontal",
4822
- "type": "string"
5398
+ ]
4823
5399
  },
4824
5400
  "slat_width": {
4825
5401
  "title": "Slat Width",
@@ -5100,26 +5676,24 @@
5100
5676
  "readOnly": true
5101
5677
  },
5102
5678
  "shade_location": {
5679
+ "title": "Shade Location",
5680
+ "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
5681
+ "default": "Interior",
5103
5682
  "allOf": [
5104
5683
  {
5105
5684
  "$ref": "#/components/schemas/ShadeLocation"
5106
5685
  }
5107
- ],
5108
- "title": "Shade Location",
5109
- "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
5110
- "default": "Interior",
5111
- "type": "string"
5686
+ ]
5112
5687
  },
5113
5688
  "control_type": {
5689
+ "title": "Control Type",
5690
+ "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
5691
+ "default": "AlwaysOn",
5114
5692
  "allOf": [
5115
5693
  {
5116
5694
  "$ref": "#/components/schemas/ControlType"
5117
5695
  }
5118
- ],
5119
- "title": "Control Type",
5120
- "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
5121
- "default": "AlwaysOn",
5122
- "type": "string"
5696
+ ]
5123
5697
  },
5124
5698
  "setpoint": {
5125
5699
  "title": "Setpoint",
@@ -5147,6 +5721,16 @@
5147
5721
  ],
5148
5722
  "additionalProperties": false
5149
5723
  },
5724
+ "EconomizerType": {
5725
+ "title": "EconomizerType",
5726
+ "description": "An enumeration.",
5727
+ "enum": [
5728
+ "NoEconomizer",
5729
+ "DifferentialDryBulb",
5730
+ "DifferentialEnthalpy"
5731
+ ],
5732
+ "type": "string"
5733
+ },
5150
5734
  "Autosize": {
5151
5735
  "title": "Autosize",
5152
5736
  "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
@@ -5187,15 +5771,14 @@
5187
5771
  "readOnly": true
5188
5772
  },
5189
5773
  "economizer_type": {
5774
+ "title": "Economizer Type",
5775
+ "description": "Text to indicate the type of air-side economizer used on the ideal air system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone.",
5776
+ "default": "DifferentialDryBulb",
5190
5777
  "allOf": [
5191
5778
  {
5192
5779
  "$ref": "#/components/schemas/EconomizerType"
5193
5780
  }
5194
- ],
5195
- "title": "Economizer Type",
5196
- "description": "Text to indicate the type of air-side economizer used on the ideal air system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone.",
5197
- "default": "DifferentialDryBulb",
5198
- "type": "string"
5781
+ ]
5199
5782
  },
5200
5783
  "demand_controlled_ventilation": {
5201
5784
  "title": "Demand Controlled Ventilation",
@@ -5247,10 +5830,10 @@
5247
5830
  },
5248
5831
  "anyOf": [
5249
5832
  {
5250
- "$ref": "#/components/schemas/NoLimit"
5833
+ "$ref": "#/components/schemas/Autosize"
5251
5834
  },
5252
5835
  {
5253
- "$ref": "#/components/schemas/Autosize"
5836
+ "$ref": "#/components/schemas/NoLimit"
5254
5837
  },
5255
5838
  {
5256
5839
  "type": "number",
@@ -5267,10 +5850,10 @@
5267
5850
  },
5268
5851
  "anyOf": [
5269
5852
  {
5270
- "$ref": "#/components/schemas/NoLimit"
5853
+ "$ref": "#/components/schemas/Autosize"
5271
5854
  },
5272
5855
  {
5273
- "$ref": "#/components/schemas/Autosize"
5856
+ "$ref": "#/components/schemas/NoLimit"
5274
5857
  },
5275
5858
  {
5276
5859
  "type": "number",
@@ -5299,9 +5882,64 @@
5299
5882
  ],
5300
5883
  "additionalProperties": false
5301
5884
  },
5302
- "ProgramTypeAbridged": {
5303
- "title": "ProgramTypeAbridged",
5304
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
5885
+ "Vintages": {
5886
+ "title": "Vintages",
5887
+ "description": "An enumeration.",
5888
+ "enum": [
5889
+ "90.1-2013",
5890
+ "90.1-2010",
5891
+ "90.1-2007",
5892
+ "90.1-2004",
5893
+ "DOE Ref 1980-2004",
5894
+ "DOE Ref Pre-1980"
5895
+ ],
5896
+ "type": "string"
5897
+ },
5898
+ "AllAirEconomizerType": {
5899
+ "title": "AllAirEconomizerType",
5900
+ "description": "An enumeration.",
5901
+ "enum": [
5902
+ "Inferred",
5903
+ "NoEconomizer",
5904
+ "DifferentialDryBulb",
5905
+ "DifferentialEnthalpy"
5906
+ ],
5907
+ "type": "string"
5908
+ },
5909
+ "VAVEquipmentType": {
5910
+ "title": "VAVEquipmentType",
5911
+ "description": "An enumeration.",
5912
+ "enum": [
5913
+ "VAV chiller with gas boiler reheat",
5914
+ "VAV chiller with central air source heat pump reheat",
5915
+ "VAV chiller with district hot water reheat",
5916
+ "VAV chiller with PFP boxes",
5917
+ "VAV chiller with gas coil reheat",
5918
+ "VAV chiller with no reheat with baseboard electric",
5919
+ "VAV chiller with no reheat with gas unit heaters",
5920
+ "VAV chiller with no reheat with zone heat pump",
5921
+ "VAV air-cooled chiller with gas boiler reheat",
5922
+ "VAV air-cooled chiller with central air source heat pump reheat",
5923
+ "VAV air-cooled chiller with district hot water reheat",
5924
+ "VAV air-cooled chiller with PFP boxes",
5925
+ "VAV air-cooled chiller with gas coil reheat",
5926
+ "VAV air-cooled chiller with no reheat with baseboard electric",
5927
+ "VAV air-cooled chiller with no reheat with gas unit heaters",
5928
+ "VAV air-cooled chiller with no reheat with zone heat pump",
5929
+ "VAV district chilled water with gas boiler reheat",
5930
+ "VAV district chilled water with central air source heat pump reheat",
5931
+ "VAV district chilled water with district hot water reheat",
5932
+ "VAV district chilled water with PFP boxes",
5933
+ "VAV district chilled water with gas coil reheat",
5934
+ "VAV district chilled water with no reheat with baseboard electric",
5935
+ "VAV district chilled water with no reheat with gas unit heaters",
5936
+ "VAV district chilled water with no reheat with zone heat pump"
5937
+ ],
5938
+ "type": "string"
5939
+ },
5940
+ "VAV": {
5941
+ "title": "VAV",
5942
+ "description": "Variable Air Volume (VAV) HVAC system.",
5305
5943
  "type": "object",
5306
5944
  "properties": {
5307
5945
  "identifier": {
@@ -5316,73 +5954,76 @@
5316
5954
  "description": "Display name of the object with no character restrictions.",
5317
5955
  "type": "string"
5318
5956
  },
5319
- "type": {
5320
- "title": "Type",
5321
- "default": "ProgramTypeAbridged",
5322
- "pattern": "^ProgramTypeAbridged$",
5323
- "type": "string",
5324
- "readOnly": true
5325
- },
5326
- "people": {
5327
- "title": "People",
5328
- "description": "People to describe the occupancy of the program. If None, no occupancy will be assumed for the program.",
5957
+ "vintage": {
5958
+ "title": "Vintage",
5959
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
5960
+ "default": "90.1-2013",
5329
5961
  "allOf": [
5330
5962
  {
5331
- "$ref": "#/components/schemas/PeopleAbridged"
5963
+ "$ref": "#/components/schemas/Vintages"
5332
5964
  }
5333
5965
  ]
5334
5966
  },
5335
- "lighting": {
5336
- "title": "Lighting",
5337
- "description": "Lighting to describe the lighting usage of the program. If None, no lighting will be assumed for the program.",
5967
+ "economizer_type": {
5968
+ "title": "Economizer Type",
5969
+ "description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.",
5970
+ "default": "Inferred",
5338
5971
  "allOf": [
5339
5972
  {
5340
- "$ref": "#/components/schemas/LightingAbridged"
5973
+ "$ref": "#/components/schemas/AllAirEconomizerType"
5341
5974
  }
5342
5975
  ]
5343
5976
  },
5344
- "electric_equipment": {
5345
- "title": "Electric Equipment",
5346
- "description": "ElectricEquipment to describe the usage of electric equipment within the program. If None, no electric equipment will be assumed.",
5347
- "allOf": [
5977
+ "sensible_heat_recovery": {
5978
+ "title": "Sensible Heat Recovery",
5979
+ "description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
5980
+ "default": {
5981
+ "type": "Autosize"
5982
+ },
5983
+ "anyOf": [
5348
5984
  {
5349
- "$ref": "#/components/schemas/ElectricEquipmentAbridged"
5350
- }
5351
- ]
5352
- },
5353
- "gas_equipment": {
5354
- "title": "Gas Equipment",
5355
- "description": "GasEquipment to describe the usage of gas equipment within the program. If None, no gas equipment will be assumed.",
5356
- "allOf": [
5985
+ "$ref": "#/components/schemas/Autosize"
5986
+ },
5357
5987
  {
5358
- "$ref": "#/components/schemas/GasEquipmentAbridged"
5988
+ "type": "number",
5989
+ "minimum": 0,
5990
+ "maximum": 1,
5991
+ "format": "double"
5359
5992
  }
5360
5993
  ]
5361
5994
  },
5362
- "infiltration": {
5363
- "title": "Infiltration",
5364
- "description": "Infiltration to describe the outdoor air leakage of the program. If None, no infiltration will be assumed for the program.",
5365
- "allOf": [
5995
+ "latent_heat_recovery": {
5996
+ "title": "Latent Heat Recovery",
5997
+ "description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
5998
+ "default": {
5999
+ "type": "Autosize"
6000
+ },
6001
+ "anyOf": [
5366
6002
  {
5367
- "$ref": "#/components/schemas/InfiltrationAbridged"
5368
- }
5369
- ]
5370
- },
5371
- "ventilation": {
5372
- "title": "Ventilation",
5373
- "description": "Ventilation to describe the minimum outdoor air requirement of the program. If None, no ventilation requirement will be assumed.",
5374
- "allOf": [
6003
+ "$ref": "#/components/schemas/Autosize"
6004
+ },
5375
6005
  {
5376
- "$ref": "#/components/schemas/VentilationAbridged"
6006
+ "type": "number",
6007
+ "minimum": 0,
6008
+ "maximum": 1,
6009
+ "format": "double"
5377
6010
  }
5378
6011
  ]
5379
6012
  },
5380
- "setpoint": {
5381
- "title": "Setpoint",
5382
- "description": "Setpoint object to describe the temperature and humidity setpoints of the program. If None, the ProgramType cannot be assigned to a Room that is conditioned.",
6013
+ "type": {
6014
+ "title": "Type",
6015
+ "default": "VAV",
6016
+ "pattern": "^VAV$",
6017
+ "type": "string",
6018
+ "readOnly": true
6019
+ },
6020
+ "equipment_type": {
6021
+ "title": "Equipment Type",
6022
+ "description": "Text for the specific type of system equipment from the VAVEquipmentType enumeration.",
6023
+ "default": "VAV chiller with gas boiler reheat",
5383
6024
  "allOf": [
5384
6025
  {
5385
- "$ref": "#/components/schemas/SetpointAbridged"
6026
+ "$ref": "#/components/schemas/VAVEquipmentType"
5386
6027
  }
5387
6028
  ]
5388
6029
  }
@@ -5392,9 +6033,21 @@
5392
6033
  ],
5393
6034
  "additionalProperties": false
5394
6035
  },
5395
- "People": {
5396
- "title": "People",
5397
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
6036
+ "PVAVEquipmentType": {
6037
+ "title": "PVAVEquipmentType",
6038
+ "description": "An enumeration.",
6039
+ "enum": [
6040
+ "PVAV with gas boiler reheat",
6041
+ "PVAV with central air source heat pump reheat",
6042
+ "PVAV with district hot water reheat",
6043
+ "PVAV with PFP boxes",
6044
+ "PVAV with gas heat with electric reheat"
6045
+ ],
6046
+ "type": "string"
6047
+ },
6048
+ "PVAV": {
6049
+ "title": "PVAV",
6050
+ "description": "Packaged Variable Air Volume (PVAV) HVAC system.",
5398
6051
  "type": "object",
5399
6052
  "properties": {
5400
6053
  "identifier": {
@@ -5404,67 +6057,58 @@
5404
6057
  "minLength": 1,
5405
6058
  "type": "string"
5406
6059
  },
5407
- "people_per_area": {
5408
- "title": "People Per Area",
5409
- "description": "People per floor area expressed as [people/m2]",
5410
- "minimum": 0,
5411
- "type": "number",
5412
- "format": "double"
6060
+ "display_name": {
6061
+ "title": "Display Name",
6062
+ "description": "Display name of the object with no character restrictions.",
6063
+ "type": "string"
5413
6064
  },
5414
- "occupancy_schedule": {
5415
- "title": "Occupancy Schedule",
5416
- "description": "A schedule for the occupancy over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the people_per_area to yield a complete occupancy profile.",
5417
- "anyOf": [
6065
+ "vintage": {
6066
+ "title": "Vintage",
6067
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
6068
+ "default": "90.1-2013",
6069
+ "allOf": [
5418
6070
  {
5419
- "$ref": "#/components/schemas/ScheduleRuleset"
5420
- },
6071
+ "$ref": "#/components/schemas/Vintages"
6072
+ }
6073
+ ]
6074
+ },
6075
+ "economizer_type": {
6076
+ "title": "Economizer Type",
6077
+ "description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.",
6078
+ "default": "Inferred",
6079
+ "allOf": [
5421
6080
  {
5422
- "$ref": "#/components/schemas/ScheduleFixedInterval"
6081
+ "$ref": "#/components/schemas/AllAirEconomizerType"
5423
6082
  }
5424
6083
  ]
5425
6084
  },
5426
- "activity_schedule": {
5427
- "title": "Activity Schedule",
5428
- "description": "A schedule for the activity of the occupants over the course of the year. The type of this schedule should be Power and the values of the schedule equal to the number of Watts given off by an individual person in the room.",
6085
+ "sensible_heat_recovery": {
6086
+ "title": "Sensible Heat Recovery",
6087
+ "description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6088
+ "default": {
6089
+ "type": "Autosize"
6090
+ },
5429
6091
  "anyOf": [
5430
6092
  {
5431
- "$ref": "#/components/schemas/ScheduleRuleset"
6093
+ "$ref": "#/components/schemas/Autosize"
5432
6094
  },
5433
6095
  {
5434
- "$ref": "#/components/schemas/ScheduleFixedInterval"
6096
+ "type": "number",
6097
+ "minimum": 0,
6098
+ "maximum": 1,
6099
+ "format": "double"
5435
6100
  }
5436
6101
  ]
5437
6102
  },
5438
- "display_name": {
5439
- "title": "Display Name",
5440
- "description": "Display name of the object with no character restrictions.",
5441
- "type": "string"
5442
- },
5443
- "type": {
5444
- "title": "Type",
5445
- "default": "People",
5446
- "pattern": "^People$",
5447
- "type": "string",
5448
- "readOnly": true
5449
- },
5450
- "radiant_fraction": {
5451
- "title": "Radiant Fraction",
5452
- "description": "The radiant fraction of sensible heat released by people. The defaultvalue is 0.30.",
5453
- "default": 0.3,
5454
- "minimum": 0,
5455
- "maximum": 1,
5456
- "type": "number",
5457
- "format": "double"
5458
- },
5459
- "latent_fraction": {
5460
- "title": "Latent Fraction",
5461
- "description": "Number for the latent fraction of heat gain due to people or an Autocalculate object.",
6103
+ "latent_heat_recovery": {
6104
+ "title": "Latent Heat Recovery",
6105
+ "description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
5462
6106
  "default": {
5463
- "type": "Autocalculate"
6107
+ "type": "Autosize"
5464
6108
  },
5465
6109
  "anyOf": [
5466
6110
  {
5467
- "$ref": "#/components/schemas/Autocalculate"
6111
+ "$ref": "#/components/schemas/Autosize"
5468
6112
  },
5469
6113
  {
5470
6114
  "type": "number",
@@ -5473,13 +6117,1362 @@
5473
6117
  "format": "double"
5474
6118
  }
5475
6119
  ]
6120
+ },
6121
+ "type": {
6122
+ "title": "Type",
6123
+ "default": "PVAV",
6124
+ "pattern": "^PVAV$",
6125
+ "type": "string",
6126
+ "readOnly": true
6127
+ },
6128
+ "equipment_type": {
6129
+ "title": "Equipment Type",
6130
+ "description": "Text for the specific type of system equipment from the VAVEquipmentType enumeration.",
6131
+ "default": "PVAV with gas boiler reheat",
6132
+ "allOf": [
6133
+ {
6134
+ "$ref": "#/components/schemas/PVAVEquipmentType"
6135
+ }
6136
+ ]
5476
6137
  }
5477
6138
  },
5478
6139
  "required": [
5479
- "identifier",
5480
- "people_per_area",
5481
- "occupancy_schedule",
5482
- "activity_schedule"
6140
+ "identifier"
6141
+ ],
6142
+ "additionalProperties": false
6143
+ },
6144
+ "PSZEquipmentType": {
6145
+ "title": "PSZEquipmentType",
6146
+ "description": "An enumeration.",
6147
+ "enum": [
6148
+ "PSZ-AC with baseboard electric",
6149
+ "PSZ-AC with baseboard gas boiler",
6150
+ "PSZ-AC with baseboard district hot water",
6151
+ "PSZ-AC with gas unit heaters",
6152
+ "PSZ-AC with electric coil",
6153
+ "PSZ-AC with gas coil",
6154
+ "PSZ-AC with gas boiler",
6155
+ "PSZ-AC with central air source heat pump",
6156
+ "PSZ-AC with district hot water",
6157
+ "PSZ-AC with no heat",
6158
+ "PSZ-AC district chilled water with baseboard electric",
6159
+ "PSZ-AC district chilled water with baseboard gas boiler",
6160
+ "PSZ-AC district chilled water with baseboard district hot water",
6161
+ "PSZ-AC district chilled water with gas unit heaters",
6162
+ "PSZ-AC district chilled water with electric coil",
6163
+ "PSZ-AC district chilled water with gas coil",
6164
+ "PSZ-AC district chilled water with gas boiler",
6165
+ "PSZ-AC district chilled water with central air source heat pump",
6166
+ "PSZ-AC district chilled water with district hot water",
6167
+ "PSZ-AC district chilled water with no heat",
6168
+ "PSZ-HP"
6169
+ ],
6170
+ "type": "string"
6171
+ },
6172
+ "PSZ": {
6173
+ "title": "PSZ",
6174
+ "description": "Packaged Single-Zone (PSZ) HVAC system.",
6175
+ "type": "object",
6176
+ "properties": {
6177
+ "identifier": {
6178
+ "title": "Identifier",
6179
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
6180
+ "maxLength": 100,
6181
+ "minLength": 1,
6182
+ "type": "string"
6183
+ },
6184
+ "display_name": {
6185
+ "title": "Display Name",
6186
+ "description": "Display name of the object with no character restrictions.",
6187
+ "type": "string"
6188
+ },
6189
+ "vintage": {
6190
+ "title": "Vintage",
6191
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
6192
+ "default": "90.1-2013",
6193
+ "allOf": [
6194
+ {
6195
+ "$ref": "#/components/schemas/Vintages"
6196
+ }
6197
+ ]
6198
+ },
6199
+ "economizer_type": {
6200
+ "title": "Economizer Type",
6201
+ "description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.",
6202
+ "default": "Inferred",
6203
+ "allOf": [
6204
+ {
6205
+ "$ref": "#/components/schemas/AllAirEconomizerType"
6206
+ }
6207
+ ]
6208
+ },
6209
+ "sensible_heat_recovery": {
6210
+ "title": "Sensible Heat Recovery",
6211
+ "description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6212
+ "default": {
6213
+ "type": "Autosize"
6214
+ },
6215
+ "anyOf": [
6216
+ {
6217
+ "$ref": "#/components/schemas/Autosize"
6218
+ },
6219
+ {
6220
+ "type": "number",
6221
+ "minimum": 0,
6222
+ "maximum": 1,
6223
+ "format": "double"
6224
+ }
6225
+ ]
6226
+ },
6227
+ "latent_heat_recovery": {
6228
+ "title": "Latent Heat Recovery",
6229
+ "description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6230
+ "default": {
6231
+ "type": "Autosize"
6232
+ },
6233
+ "anyOf": [
6234
+ {
6235
+ "$ref": "#/components/schemas/Autosize"
6236
+ },
6237
+ {
6238
+ "type": "number",
6239
+ "minimum": 0,
6240
+ "maximum": 1,
6241
+ "format": "double"
6242
+ }
6243
+ ]
6244
+ },
6245
+ "type": {
6246
+ "title": "Type",
6247
+ "default": "PSZ",
6248
+ "pattern": "^PSZ$",
6249
+ "type": "string",
6250
+ "readOnly": true
6251
+ },
6252
+ "equipment_type": {
6253
+ "title": "Equipment Type",
6254
+ "description": "Text for the specific type of system equipment from the PVAVEquipmentType enumeration.",
6255
+ "default": "PSZ-AC with baseboard electric",
6256
+ "allOf": [
6257
+ {
6258
+ "$ref": "#/components/schemas/PSZEquipmentType"
6259
+ }
6260
+ ]
6261
+ }
6262
+ },
6263
+ "required": [
6264
+ "identifier"
6265
+ ],
6266
+ "additionalProperties": false
6267
+ },
6268
+ "PTACEquipmentType": {
6269
+ "title": "PTACEquipmentType",
6270
+ "description": "An enumeration.",
6271
+ "enum": [
6272
+ "PTAC with baseboard electric",
6273
+ "PTAC with baseboard gas boiler",
6274
+ "PTAC with baseboard district hot water",
6275
+ "PTAC with gas unit heaters",
6276
+ "PTAC with electric coil",
6277
+ "PTAC with gas coil",
6278
+ "PTAC with gas boiler",
6279
+ "PTAC with central air source heat pump",
6280
+ "PTAC with district hot water",
6281
+ "PTAC with no heat",
6282
+ "PTHP"
6283
+ ],
6284
+ "type": "string"
6285
+ },
6286
+ "PTAC": {
6287
+ "title": "PTAC",
6288
+ "description": "Packaged Terminal Air Conditioning (PTAC) or Heat Pump (PTHP) HVAC system.",
6289
+ "type": "object",
6290
+ "properties": {
6291
+ "identifier": {
6292
+ "title": "Identifier",
6293
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
6294
+ "maxLength": 100,
6295
+ "minLength": 1,
6296
+ "type": "string"
6297
+ },
6298
+ "display_name": {
6299
+ "title": "Display Name",
6300
+ "description": "Display name of the object with no character restrictions.",
6301
+ "type": "string"
6302
+ },
6303
+ "vintage": {
6304
+ "title": "Vintage",
6305
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
6306
+ "default": "90.1-2013",
6307
+ "allOf": [
6308
+ {
6309
+ "$ref": "#/components/schemas/Vintages"
6310
+ }
6311
+ ]
6312
+ },
6313
+ "economizer_type": {
6314
+ "title": "Economizer Type",
6315
+ "description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.",
6316
+ "default": "Inferred",
6317
+ "allOf": [
6318
+ {
6319
+ "$ref": "#/components/schemas/AllAirEconomizerType"
6320
+ }
6321
+ ]
6322
+ },
6323
+ "sensible_heat_recovery": {
6324
+ "title": "Sensible Heat Recovery",
6325
+ "description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6326
+ "default": {
6327
+ "type": "Autosize"
6328
+ },
6329
+ "anyOf": [
6330
+ {
6331
+ "$ref": "#/components/schemas/Autosize"
6332
+ },
6333
+ {
6334
+ "type": "number",
6335
+ "minimum": 0,
6336
+ "maximum": 1,
6337
+ "format": "double"
6338
+ }
6339
+ ]
6340
+ },
6341
+ "latent_heat_recovery": {
6342
+ "title": "Latent Heat Recovery",
6343
+ "description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6344
+ "default": {
6345
+ "type": "Autosize"
6346
+ },
6347
+ "anyOf": [
6348
+ {
6349
+ "$ref": "#/components/schemas/Autosize"
6350
+ },
6351
+ {
6352
+ "type": "number",
6353
+ "minimum": 0,
6354
+ "maximum": 1,
6355
+ "format": "double"
6356
+ }
6357
+ ]
6358
+ },
6359
+ "type": {
6360
+ "title": "Type",
6361
+ "default": "PTAC",
6362
+ "pattern": "^PTAC$",
6363
+ "type": "string",
6364
+ "readOnly": true
6365
+ },
6366
+ "equipment_type": {
6367
+ "title": "Equipment Type",
6368
+ "description": "Text for the specific type of system equipment from the PTACEquipmentType enumeration.",
6369
+ "default": "PTAC with baseboard electric",
6370
+ "allOf": [
6371
+ {
6372
+ "$ref": "#/components/schemas/PTACEquipmentType"
6373
+ }
6374
+ ]
6375
+ }
6376
+ },
6377
+ "required": [
6378
+ "identifier"
6379
+ ],
6380
+ "additionalProperties": false
6381
+ },
6382
+ "FurnaceEquipmentType": {
6383
+ "title": "FurnaceEquipmentType",
6384
+ "description": "An enumeration.",
6385
+ "enum": [
6386
+ "Forced air furnace"
6387
+ ],
6388
+ "type": "string"
6389
+ },
6390
+ "ForcedAirFurnace": {
6391
+ "title": "ForcedAirFurnace",
6392
+ "description": "Forced Air Furnace HVAC system. Intended for spaces only requiring heating.",
6393
+ "type": "object",
6394
+ "properties": {
6395
+ "identifier": {
6396
+ "title": "Identifier",
6397
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
6398
+ "maxLength": 100,
6399
+ "minLength": 1,
6400
+ "type": "string"
6401
+ },
6402
+ "display_name": {
6403
+ "title": "Display Name",
6404
+ "description": "Display name of the object with no character restrictions.",
6405
+ "type": "string"
6406
+ },
6407
+ "vintage": {
6408
+ "title": "Vintage",
6409
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
6410
+ "default": "90.1-2013",
6411
+ "allOf": [
6412
+ {
6413
+ "$ref": "#/components/schemas/Vintages"
6414
+ }
6415
+ ]
6416
+ },
6417
+ "economizer_type": {
6418
+ "title": "Economizer Type",
6419
+ "description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.",
6420
+ "default": "Inferred",
6421
+ "allOf": [
6422
+ {
6423
+ "$ref": "#/components/schemas/AllAirEconomizerType"
6424
+ }
6425
+ ]
6426
+ },
6427
+ "sensible_heat_recovery": {
6428
+ "title": "Sensible Heat Recovery",
6429
+ "description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6430
+ "default": {
6431
+ "type": "Autosize"
6432
+ },
6433
+ "anyOf": [
6434
+ {
6435
+ "$ref": "#/components/schemas/Autosize"
6436
+ },
6437
+ {
6438
+ "type": "number",
6439
+ "minimum": 0,
6440
+ "maximum": 1,
6441
+ "format": "double"
6442
+ }
6443
+ ]
6444
+ },
6445
+ "latent_heat_recovery": {
6446
+ "title": "Latent Heat Recovery",
6447
+ "description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6448
+ "default": {
6449
+ "type": "Autosize"
6450
+ },
6451
+ "anyOf": [
6452
+ {
6453
+ "$ref": "#/components/schemas/Autosize"
6454
+ },
6455
+ {
6456
+ "type": "number",
6457
+ "minimum": 0,
6458
+ "maximum": 1,
6459
+ "format": "double"
6460
+ }
6461
+ ]
6462
+ },
6463
+ "type": {
6464
+ "title": "Type",
6465
+ "default": "ForcedAirFurnace",
6466
+ "pattern": "^ForcedAirFurnace$",
6467
+ "type": "string",
6468
+ "readOnly": true
6469
+ },
6470
+ "equipment_type": {
6471
+ "title": "Equipment Type",
6472
+ "description": "Text for the specific type of system equipment from the FurnaceEquipmentType enumeration.",
6473
+ "default": "Forced air furnace",
6474
+ "allOf": [
6475
+ {
6476
+ "$ref": "#/components/schemas/FurnaceEquipmentType"
6477
+ }
6478
+ ]
6479
+ }
6480
+ },
6481
+ "required": [
6482
+ "identifier"
6483
+ ],
6484
+ "additionalProperties": false
6485
+ },
6486
+ "FCUwithDOASEquipmentType": {
6487
+ "title": "FCUwithDOASEquipmentType",
6488
+ "description": "An enumeration.",
6489
+ "enum": [
6490
+ "DOAS with fan coil chiller with boiler",
6491
+ "DOAS with fan coil chiller with central air source heat pump",
6492
+ "DOAS with fan coil chiller with district hot water",
6493
+ "DOAS with fan coil chiller with baseboard electric",
6494
+ "DOAS with fan coil chiller with gas unit heaters",
6495
+ "DOAS with fan coil chiller with no heat",
6496
+ "DOAS with fan coil air-cooled chiller with boiler",
6497
+ "DOAS with fan coil air-cooled chiller with central air source heat pump",
6498
+ "DOAS with fan coil air-cooled chiller with district hot water",
6499
+ "DOAS with fan coil air-cooled chiller with baseboard electric",
6500
+ "DOAS with fan coil air-cooled chiller with gas unit heaters",
6501
+ "DOAS with fan coil air-cooled chiller with no heat",
6502
+ "DOAS with fan coil district chilled water with boiler",
6503
+ "DOAS with fan coil district chilled water with central air source heat pump",
6504
+ "DOAS with fan coil district chilled water with district hot water",
6505
+ "DOAS with fan coil district chilled water with baseboard electric",
6506
+ "DOAS with fan coil district chilled water with gas unit heaters",
6507
+ "DOAS with fan coil district chilled water with no heat"
6508
+ ],
6509
+ "type": "string"
6510
+ },
6511
+ "FCUwithDOAS": {
6512
+ "title": "FCUwithDOAS",
6513
+ "description": "Fan Coil Unit (FCU) with DOAS HVAC system.",
6514
+ "type": "object",
6515
+ "properties": {
6516
+ "identifier": {
6517
+ "title": "Identifier",
6518
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
6519
+ "maxLength": 100,
6520
+ "minLength": 1,
6521
+ "type": "string"
6522
+ },
6523
+ "display_name": {
6524
+ "title": "Display Name",
6525
+ "description": "Display name of the object with no character restrictions.",
6526
+ "type": "string"
6527
+ },
6528
+ "vintage": {
6529
+ "title": "Vintage",
6530
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
6531
+ "default": "90.1-2013",
6532
+ "allOf": [
6533
+ {
6534
+ "$ref": "#/components/schemas/Vintages"
6535
+ }
6536
+ ]
6537
+ },
6538
+ "sensible_heat_recovery": {
6539
+ "title": "Sensible Heat Recovery",
6540
+ "description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6541
+ "default": {
6542
+ "type": "Autosize"
6543
+ },
6544
+ "anyOf": [
6545
+ {
6546
+ "$ref": "#/components/schemas/Autosize"
6547
+ },
6548
+ {
6549
+ "type": "number",
6550
+ "minimum": 0,
6551
+ "maximum": 1,
6552
+ "format": "double"
6553
+ }
6554
+ ]
6555
+ },
6556
+ "latent_heat_recovery": {
6557
+ "title": "Latent Heat Recovery",
6558
+ "description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6559
+ "default": {
6560
+ "type": "Autosize"
6561
+ },
6562
+ "anyOf": [
6563
+ {
6564
+ "$ref": "#/components/schemas/Autosize"
6565
+ },
6566
+ {
6567
+ "type": "number",
6568
+ "minimum": 0,
6569
+ "maximum": 1,
6570
+ "format": "double"
6571
+ }
6572
+ ]
6573
+ },
6574
+ "type": {
6575
+ "title": "Type",
6576
+ "default": "FCUwithDOAS",
6577
+ "pattern": "^FCUwithDOAS$",
6578
+ "type": "string",
6579
+ "readOnly": true
6580
+ },
6581
+ "equipment_type": {
6582
+ "title": "Equipment Type",
6583
+ "description": "Text for the specific type of system equipment from the FCUwithDOASEquipmentType enumeration.",
6584
+ "default": "DOAS with fan coil chiller with boiler",
6585
+ "allOf": [
6586
+ {
6587
+ "$ref": "#/components/schemas/FCUwithDOASEquipmentType"
6588
+ }
6589
+ ]
6590
+ }
6591
+ },
6592
+ "required": [
6593
+ "identifier"
6594
+ ],
6595
+ "additionalProperties": false
6596
+ },
6597
+ "WSHPwithDOASEquipmentType": {
6598
+ "title": "WSHPwithDOASEquipmentType",
6599
+ "description": "An enumeration.",
6600
+ "enum": [
6601
+ "DOAS with water source heat pumps fluid cooler with boiler",
6602
+ "DOAS with water source heat pumps cooling tower with boiler",
6603
+ "DOAS with water source heat pumps with ground source heat pump",
6604
+ "DOAS with water source heat pumps district chilled water with district hot water"
6605
+ ],
6606
+ "type": "string"
6607
+ },
6608
+ "WSHPwithDOAS": {
6609
+ "title": "WSHPwithDOAS",
6610
+ "description": "Water Source Heat Pump (WSHP) with DOAS HVAC system.",
6611
+ "type": "object",
6612
+ "properties": {
6613
+ "identifier": {
6614
+ "title": "Identifier",
6615
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
6616
+ "maxLength": 100,
6617
+ "minLength": 1,
6618
+ "type": "string"
6619
+ },
6620
+ "display_name": {
6621
+ "title": "Display Name",
6622
+ "description": "Display name of the object with no character restrictions.",
6623
+ "type": "string"
6624
+ },
6625
+ "vintage": {
6626
+ "title": "Vintage",
6627
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
6628
+ "default": "90.1-2013",
6629
+ "allOf": [
6630
+ {
6631
+ "$ref": "#/components/schemas/Vintages"
6632
+ }
6633
+ ]
6634
+ },
6635
+ "sensible_heat_recovery": {
6636
+ "title": "Sensible Heat Recovery",
6637
+ "description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6638
+ "default": {
6639
+ "type": "Autosize"
6640
+ },
6641
+ "anyOf": [
6642
+ {
6643
+ "$ref": "#/components/schemas/Autosize"
6644
+ },
6645
+ {
6646
+ "type": "number",
6647
+ "minimum": 0,
6648
+ "maximum": 1,
6649
+ "format": "double"
6650
+ }
6651
+ ]
6652
+ },
6653
+ "latent_heat_recovery": {
6654
+ "title": "Latent Heat Recovery",
6655
+ "description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6656
+ "default": {
6657
+ "type": "Autosize"
6658
+ },
6659
+ "anyOf": [
6660
+ {
6661
+ "$ref": "#/components/schemas/Autosize"
6662
+ },
6663
+ {
6664
+ "type": "number",
6665
+ "minimum": 0,
6666
+ "maximum": 1,
6667
+ "format": "double"
6668
+ }
6669
+ ]
6670
+ },
6671
+ "type": {
6672
+ "title": "Type",
6673
+ "default": "WSHPwithDOAS",
6674
+ "pattern": "^WSHPwithDOAS$",
6675
+ "type": "string",
6676
+ "readOnly": true
6677
+ },
6678
+ "equipment_type": {
6679
+ "title": "Equipment Type",
6680
+ "description": "Text for the specific type of system equipment from the WSHPwithDOASEquipmentType enumeration.",
6681
+ "default": "DOAS with water source heat pumps fluid cooler with boiler",
6682
+ "allOf": [
6683
+ {
6684
+ "$ref": "#/components/schemas/WSHPwithDOASEquipmentType"
6685
+ }
6686
+ ]
6687
+ }
6688
+ },
6689
+ "required": [
6690
+ "identifier"
6691
+ ],
6692
+ "additionalProperties": false
6693
+ },
6694
+ "VRFwithDOASEquipmentType": {
6695
+ "title": "VRFwithDOASEquipmentType",
6696
+ "description": "An enumeration.",
6697
+ "enum": [
6698
+ "DOAS with VRF"
6699
+ ],
6700
+ "type": "string"
6701
+ },
6702
+ "VRFwithDOAS": {
6703
+ "title": "VRFwithDOAS",
6704
+ "description": "Variable Refrigerant Flow (VRF) with DOAS HVAC system.",
6705
+ "type": "object",
6706
+ "properties": {
6707
+ "identifier": {
6708
+ "title": "Identifier",
6709
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
6710
+ "maxLength": 100,
6711
+ "minLength": 1,
6712
+ "type": "string"
6713
+ },
6714
+ "display_name": {
6715
+ "title": "Display Name",
6716
+ "description": "Display name of the object with no character restrictions.",
6717
+ "type": "string"
6718
+ },
6719
+ "vintage": {
6720
+ "title": "Vintage",
6721
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
6722
+ "default": "90.1-2013",
6723
+ "allOf": [
6724
+ {
6725
+ "$ref": "#/components/schemas/Vintages"
6726
+ }
6727
+ ]
6728
+ },
6729
+ "sensible_heat_recovery": {
6730
+ "title": "Sensible Heat Recovery",
6731
+ "description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6732
+ "default": {
6733
+ "type": "Autosize"
6734
+ },
6735
+ "anyOf": [
6736
+ {
6737
+ "$ref": "#/components/schemas/Autosize"
6738
+ },
6739
+ {
6740
+ "type": "number",
6741
+ "minimum": 0,
6742
+ "maximum": 1,
6743
+ "format": "double"
6744
+ }
6745
+ ]
6746
+ },
6747
+ "latent_heat_recovery": {
6748
+ "title": "Latent Heat Recovery",
6749
+ "description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.",
6750
+ "default": {
6751
+ "type": "Autosize"
6752
+ },
6753
+ "anyOf": [
6754
+ {
6755
+ "$ref": "#/components/schemas/Autosize"
6756
+ },
6757
+ {
6758
+ "type": "number",
6759
+ "minimum": 0,
6760
+ "maximum": 1,
6761
+ "format": "double"
6762
+ }
6763
+ ]
6764
+ },
6765
+ "type": {
6766
+ "title": "Type",
6767
+ "default": "VRFwithDOAS",
6768
+ "pattern": "^VRFwithDOAS$",
6769
+ "type": "string",
6770
+ "readOnly": true
6771
+ },
6772
+ "equipment_type": {
6773
+ "title": "Equipment Type",
6774
+ "description": "Text for the specific type of system equipment from the VRFwithDOASEquipmentType enumeration.",
6775
+ "default": "DOAS with VRF",
6776
+ "allOf": [
6777
+ {
6778
+ "$ref": "#/components/schemas/VRFwithDOASEquipmentType"
6779
+ }
6780
+ ]
6781
+ }
6782
+ },
6783
+ "required": [
6784
+ "identifier"
6785
+ ],
6786
+ "additionalProperties": false
6787
+ },
6788
+ "FCUEquipmentType": {
6789
+ "title": "FCUEquipmentType",
6790
+ "description": "An enumeration.",
6791
+ "enum": [
6792
+ "Fan coil chiller with boiler",
6793
+ "Fan coil chiller with central air source heat pump",
6794
+ "Fan coil chiller with district hot water",
6795
+ "Fan coil chiller with baseboard electric",
6796
+ "Fan coil chiller with gas unit heaters",
6797
+ "Fan coil chiller with no heat",
6798
+ "Fan coil air-cooled chiller with boiler",
6799
+ "Fan coil air-cooled chiller with central air source heat pump",
6800
+ "Fan coil air-cooled chiller with district hot water",
6801
+ "Fan coil air-cooled chiller with baseboard electric",
6802
+ "Fan coil air-cooled chiller with gas unit heaters",
6803
+ "Fan coil air-cooled chiller with no heat",
6804
+ "Fan coil district chilled water with boiler",
6805
+ "Fan coil district chilled water with central air source heat pump",
6806
+ "Fan coil district chilled water with district hot water",
6807
+ "Fan coil district chilled water with baseboard electric",
6808
+ "Fan coil district chilled water with gas unit heaters",
6809
+ "Fan coil district chilled water with no heat"
6810
+ ],
6811
+ "type": "string"
6812
+ },
6813
+ "FCU": {
6814
+ "title": "FCU",
6815
+ "description": "Fan Coil Unit (FCU) heating/cooling system (with no ventilation).",
6816
+ "type": "object",
6817
+ "properties": {
6818
+ "identifier": {
6819
+ "title": "Identifier",
6820
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
6821
+ "maxLength": 100,
6822
+ "minLength": 1,
6823
+ "type": "string"
6824
+ },
6825
+ "display_name": {
6826
+ "title": "Display Name",
6827
+ "description": "Display name of the object with no character restrictions.",
6828
+ "type": "string"
6829
+ },
6830
+ "vintage": {
6831
+ "title": "Vintage",
6832
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
6833
+ "default": "90.1-2013",
6834
+ "allOf": [
6835
+ {
6836
+ "$ref": "#/components/schemas/Vintages"
6837
+ }
6838
+ ]
6839
+ },
6840
+ "type": {
6841
+ "title": "Type",
6842
+ "default": "FCU",
6843
+ "pattern": "^FCU$",
6844
+ "type": "string",
6845
+ "readOnly": true
6846
+ },
6847
+ "equipment_type": {
6848
+ "title": "Equipment Type",
6849
+ "description": "Text for the specific type of system equipment from the FCUEquipmentType enumeration.",
6850
+ "default": "Fan coil chiller with boiler",
6851
+ "allOf": [
6852
+ {
6853
+ "$ref": "#/components/schemas/FCUEquipmentType"
6854
+ }
6855
+ ]
6856
+ }
6857
+ },
6858
+ "required": [
6859
+ "identifier"
6860
+ ],
6861
+ "additionalProperties": false
6862
+ },
6863
+ "WSHPEquipmentType": {
6864
+ "title": "WSHPEquipmentType",
6865
+ "description": "An enumeration.",
6866
+ "enum": [
6867
+ "Water source heat pumps fluid cooler with boiler",
6868
+ "Water source heat pumps cooling tower with boiler",
6869
+ "Water source heat pumps with ground source heat pump",
6870
+ "Water source heat pumps district chilled water with district hot water"
6871
+ ],
6872
+ "type": "string"
6873
+ },
6874
+ "WSHP": {
6875
+ "title": "WSHP",
6876
+ "description": "Direct evaporative cooling systems (with optional heating).",
6877
+ "type": "object",
6878
+ "properties": {
6879
+ "identifier": {
6880
+ "title": "Identifier",
6881
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
6882
+ "maxLength": 100,
6883
+ "minLength": 1,
6884
+ "type": "string"
6885
+ },
6886
+ "display_name": {
6887
+ "title": "Display Name",
6888
+ "description": "Display name of the object with no character restrictions.",
6889
+ "type": "string"
6890
+ },
6891
+ "vintage": {
6892
+ "title": "Vintage",
6893
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
6894
+ "default": "90.1-2013",
6895
+ "allOf": [
6896
+ {
6897
+ "$ref": "#/components/schemas/Vintages"
6898
+ }
6899
+ ]
6900
+ },
6901
+ "type": {
6902
+ "title": "Type",
6903
+ "default": "WSHP",
6904
+ "pattern": "^WSHP$",
6905
+ "type": "string",
6906
+ "readOnly": true
6907
+ },
6908
+ "equipment_type": {
6909
+ "title": "Equipment Type",
6910
+ "description": "Text for the specific type of system equipment from the WSHPEquipmentType enumeration.",
6911
+ "default": "Water source heat pumps fluid cooler with boiler",
6912
+ "allOf": [
6913
+ {
6914
+ "$ref": "#/components/schemas/WSHPEquipmentType"
6915
+ }
6916
+ ]
6917
+ }
6918
+ },
6919
+ "required": [
6920
+ "identifier"
6921
+ ],
6922
+ "additionalProperties": false
6923
+ },
6924
+ "VRFEquipmentType": {
6925
+ "title": "VRFEquipmentType",
6926
+ "description": "An enumeration.",
6927
+ "enum": [
6928
+ "VRF"
6929
+ ],
6930
+ "type": "string"
6931
+ },
6932
+ "VRF": {
6933
+ "title": "VRF",
6934
+ "description": "Variable Refrigerant Flow (VRF) heating/cooling system (with no ventilation).",
6935
+ "type": "object",
6936
+ "properties": {
6937
+ "identifier": {
6938
+ "title": "Identifier",
6939
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
6940
+ "maxLength": 100,
6941
+ "minLength": 1,
6942
+ "type": "string"
6943
+ },
6944
+ "display_name": {
6945
+ "title": "Display Name",
6946
+ "description": "Display name of the object with no character restrictions.",
6947
+ "type": "string"
6948
+ },
6949
+ "vintage": {
6950
+ "title": "Vintage",
6951
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
6952
+ "default": "90.1-2013",
6953
+ "allOf": [
6954
+ {
6955
+ "$ref": "#/components/schemas/Vintages"
6956
+ }
6957
+ ]
6958
+ },
6959
+ "type": {
6960
+ "title": "Type",
6961
+ "default": "VRF",
6962
+ "pattern": "^VRF$",
6963
+ "type": "string",
6964
+ "readOnly": true
6965
+ },
6966
+ "equipment_type": {
6967
+ "title": "Equipment Type",
6968
+ "description": "Text for the specific type of system equipment from the VRFEquipmentType enumeration.",
6969
+ "default": "VRF",
6970
+ "allOf": [
6971
+ {
6972
+ "$ref": "#/components/schemas/VRFEquipmentType"
6973
+ }
6974
+ ]
6975
+ }
6976
+ },
6977
+ "required": [
6978
+ "identifier"
6979
+ ],
6980
+ "additionalProperties": false
6981
+ },
6982
+ "BaseboardEquipmentType": {
6983
+ "title": "BaseboardEquipmentType",
6984
+ "description": "An enumeration.",
6985
+ "enum": [
6986
+ "Baseboard electric",
6987
+ "Baseboard gas boiler",
6988
+ "Baseboard central air source heat pump",
6989
+ "Baseboard district hot water"
6990
+ ],
6991
+ "type": "string"
6992
+ },
6993
+ "Baseboard": {
6994
+ "title": "Baseboard",
6995
+ "description": "Baseboard heating system. Intended for spaces only requiring heating.",
6996
+ "type": "object",
6997
+ "properties": {
6998
+ "identifier": {
6999
+ "title": "Identifier",
7000
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
7001
+ "maxLength": 100,
7002
+ "minLength": 1,
7003
+ "type": "string"
7004
+ },
7005
+ "display_name": {
7006
+ "title": "Display Name",
7007
+ "description": "Display name of the object with no character restrictions.",
7008
+ "type": "string"
7009
+ },
7010
+ "vintage": {
7011
+ "title": "Vintage",
7012
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
7013
+ "default": "90.1-2013",
7014
+ "allOf": [
7015
+ {
7016
+ "$ref": "#/components/schemas/Vintages"
7017
+ }
7018
+ ]
7019
+ },
7020
+ "type": {
7021
+ "title": "Type",
7022
+ "default": "Baseboard",
7023
+ "pattern": "^Baseboard$",
7024
+ "type": "string",
7025
+ "readOnly": true
7026
+ },
7027
+ "equipment_type": {
7028
+ "title": "Equipment Type",
7029
+ "description": "Text for the specific type of system equipment from the BaseboardEquipmentType enumeration.",
7030
+ "default": "Baseboard electric",
7031
+ "allOf": [
7032
+ {
7033
+ "$ref": "#/components/schemas/BaseboardEquipmentType"
7034
+ }
7035
+ ]
7036
+ }
7037
+ },
7038
+ "required": [
7039
+ "identifier"
7040
+ ],
7041
+ "additionalProperties": false
7042
+ },
7043
+ "EvaporativeCoolerEquipmentType": {
7044
+ "title": "EvaporativeCoolerEquipmentType",
7045
+ "description": "An enumeration.",
7046
+ "enum": [
7047
+ "Direct evap coolers with baseboard electric",
7048
+ "Direct evap coolers with baseboard gas boiler",
7049
+ "Direct evap coolers with baseboard central air source heat pump",
7050
+ "Direct evap coolers with baseboard district hot water",
7051
+ "Direct evap coolers with forced air furnace",
7052
+ "Direct evap coolers with gas unit heaters",
7053
+ "Direct evap coolers with no heat"
7054
+ ],
7055
+ "type": "string"
7056
+ },
7057
+ "EvaporativeCooler": {
7058
+ "title": "EvaporativeCooler",
7059
+ "description": "Direct evaporative cooling systems (with optional heating).",
7060
+ "type": "object",
7061
+ "properties": {
7062
+ "identifier": {
7063
+ "title": "Identifier",
7064
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
7065
+ "maxLength": 100,
7066
+ "minLength": 1,
7067
+ "type": "string"
7068
+ },
7069
+ "display_name": {
7070
+ "title": "Display Name",
7071
+ "description": "Display name of the object with no character restrictions.",
7072
+ "type": "string"
7073
+ },
7074
+ "vintage": {
7075
+ "title": "Vintage",
7076
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
7077
+ "default": "90.1-2013",
7078
+ "allOf": [
7079
+ {
7080
+ "$ref": "#/components/schemas/Vintages"
7081
+ }
7082
+ ]
7083
+ },
7084
+ "type": {
7085
+ "title": "Type",
7086
+ "default": "EvaporativeCooler",
7087
+ "pattern": "^EvaporativeCooler$",
7088
+ "type": "string",
7089
+ "readOnly": true
7090
+ },
7091
+ "equipment_type": {
7092
+ "title": "Equipment Type",
7093
+ "description": "Text for the specific type of system equipment from the EvaporativeCoolerEquipmentType enumeration.",
7094
+ "default": "Direct evap coolers with baseboard electric",
7095
+ "allOf": [
7096
+ {
7097
+ "$ref": "#/components/schemas/EvaporativeCoolerEquipmentType"
7098
+ }
7099
+ ]
7100
+ }
7101
+ },
7102
+ "required": [
7103
+ "identifier"
7104
+ ],
7105
+ "additionalProperties": false
7106
+ },
7107
+ "ResidentialEquipmentType": {
7108
+ "title": "ResidentialEquipmentType",
7109
+ "description": "An enumeration.",
7110
+ "enum": [
7111
+ "Residential AC with baseboard electric",
7112
+ "Residential AC with baseboard gas boiler",
7113
+ "Residential AC with baseboard central air source heat pump",
7114
+ "Residential AC with baseboard district hot water",
7115
+ "Residential AC with residential forced air furnace",
7116
+ "Residential AC with no heat",
7117
+ "Residential heat pump",
7118
+ "Residential heat pump with no cooling",
7119
+ "Residential forced air furnace"
7120
+ ],
7121
+ "type": "string"
7122
+ },
7123
+ "Residential": {
7124
+ "title": "Residential",
7125
+ "description": "Residential Air Conditioning, Heat Pump or Furnace system.",
7126
+ "type": "object",
7127
+ "properties": {
7128
+ "identifier": {
7129
+ "title": "Identifier",
7130
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
7131
+ "maxLength": 100,
7132
+ "minLength": 1,
7133
+ "type": "string"
7134
+ },
7135
+ "display_name": {
7136
+ "title": "Display Name",
7137
+ "description": "Display name of the object with no character restrictions.",
7138
+ "type": "string"
7139
+ },
7140
+ "vintage": {
7141
+ "title": "Vintage",
7142
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
7143
+ "default": "90.1-2013",
7144
+ "allOf": [
7145
+ {
7146
+ "$ref": "#/components/schemas/Vintages"
7147
+ }
7148
+ ]
7149
+ },
7150
+ "type": {
7151
+ "title": "Type",
7152
+ "default": "Residential",
7153
+ "pattern": "^Residential$",
7154
+ "type": "string",
7155
+ "readOnly": true
7156
+ },
7157
+ "equipment_type": {
7158
+ "title": "Equipment Type",
7159
+ "description": "Text for the specific type of system equipment from the ResidentialEquipmentType enumeration.",
7160
+ "default": "Residential AC with baseboard electric",
7161
+ "allOf": [
7162
+ {
7163
+ "$ref": "#/components/schemas/ResidentialEquipmentType"
7164
+ }
7165
+ ]
7166
+ }
7167
+ },
7168
+ "required": [
7169
+ "identifier"
7170
+ ],
7171
+ "additionalProperties": false
7172
+ },
7173
+ "WindowACEquipmentType": {
7174
+ "title": "WindowACEquipmentType",
7175
+ "description": "An enumeration.",
7176
+ "enum": [
7177
+ "Window AC with baseboard electric",
7178
+ "Window AC with baseboard gas boiler",
7179
+ "Window AC with baseboard central air source heat pump",
7180
+ "Window AC with baseboard district hot water",
7181
+ "Window AC with forced air furnace",
7182
+ "Window AC with unit heaters",
7183
+ "Window AC with no heat"
7184
+ ],
7185
+ "type": "string"
7186
+ },
7187
+ "WindowAC": {
7188
+ "title": "WindowAC",
7189
+ "description": "Window Air Conditioning cooling system (with optional heating).",
7190
+ "type": "object",
7191
+ "properties": {
7192
+ "identifier": {
7193
+ "title": "Identifier",
7194
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
7195
+ "maxLength": 100,
7196
+ "minLength": 1,
7197
+ "type": "string"
7198
+ },
7199
+ "display_name": {
7200
+ "title": "Display Name",
7201
+ "description": "Display name of the object with no character restrictions.",
7202
+ "type": "string"
7203
+ },
7204
+ "vintage": {
7205
+ "title": "Vintage",
7206
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
7207
+ "default": "90.1-2013",
7208
+ "allOf": [
7209
+ {
7210
+ "$ref": "#/components/schemas/Vintages"
7211
+ }
7212
+ ]
7213
+ },
7214
+ "type": {
7215
+ "title": "Type",
7216
+ "default": "WindowAC",
7217
+ "pattern": "^WindowAC$",
7218
+ "type": "string",
7219
+ "readOnly": true
7220
+ },
7221
+ "equipment_type": {
7222
+ "title": "Equipment Type",
7223
+ "description": "Text for the specific type of system equipment from the WindowACEquipmentType enumeration.",
7224
+ "default": "Window AC with baseboard electric",
7225
+ "allOf": [
7226
+ {
7227
+ "$ref": "#/components/schemas/WindowACEquipmentType"
7228
+ }
7229
+ ]
7230
+ }
7231
+ },
7232
+ "required": [
7233
+ "identifier"
7234
+ ],
7235
+ "additionalProperties": false
7236
+ },
7237
+ "GasUnitHeaterEquipmentType": {
7238
+ "title": "GasUnitHeaterEquipmentType",
7239
+ "description": "An enumeration.",
7240
+ "enum": [
7241
+ "Gas unit heaters"
7242
+ ],
7243
+ "type": "string"
7244
+ },
7245
+ "GasUnitHeater": {
7246
+ "title": "GasUnitHeater",
7247
+ "description": "Gas unit heating system. Intended for spaces only requiring heating.",
7248
+ "type": "object",
7249
+ "properties": {
7250
+ "identifier": {
7251
+ "title": "Identifier",
7252
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
7253
+ "maxLength": 100,
7254
+ "minLength": 1,
7255
+ "type": "string"
7256
+ },
7257
+ "display_name": {
7258
+ "title": "Display Name",
7259
+ "description": "Display name of the object with no character restrictions.",
7260
+ "type": "string"
7261
+ },
7262
+ "vintage": {
7263
+ "title": "Vintage",
7264
+ "description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
7265
+ "default": "90.1-2013",
7266
+ "allOf": [
7267
+ {
7268
+ "$ref": "#/components/schemas/Vintages"
7269
+ }
7270
+ ]
7271
+ },
7272
+ "type": {
7273
+ "title": "Type",
7274
+ "default": "GasUnitHeater",
7275
+ "pattern": "^GasUnitHeater$",
7276
+ "type": "string",
7277
+ "readOnly": true
7278
+ },
7279
+ "equipment_type": {
7280
+ "title": "Equipment Type",
7281
+ "description": "Text for the specific type of system equipment from the GasUnitHeaterEquipmentType enumeration.",
7282
+ "default": "Gas unit heaters",
7283
+ "allOf": [
7284
+ {
7285
+ "$ref": "#/components/schemas/GasUnitHeaterEquipmentType"
7286
+ }
7287
+ ]
7288
+ }
7289
+ },
7290
+ "required": [
7291
+ "identifier"
7292
+ ],
7293
+ "additionalProperties": false
7294
+ },
7295
+ "ProgramTypeAbridged": {
7296
+ "title": "ProgramTypeAbridged",
7297
+ "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
7298
+ "type": "object",
7299
+ "properties": {
7300
+ "identifier": {
7301
+ "title": "Identifier",
7302
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
7303
+ "maxLength": 100,
7304
+ "minLength": 1,
7305
+ "type": "string"
7306
+ },
7307
+ "display_name": {
7308
+ "title": "Display Name",
7309
+ "description": "Display name of the object with no character restrictions.",
7310
+ "type": "string"
7311
+ },
7312
+ "type": {
7313
+ "title": "Type",
7314
+ "default": "ProgramTypeAbridged",
7315
+ "pattern": "^ProgramTypeAbridged$",
7316
+ "type": "string",
7317
+ "readOnly": true
7318
+ },
7319
+ "people": {
7320
+ "title": "People",
7321
+ "description": "People to describe the occupancy of the program. If None, no occupancy will be assumed for the program.",
7322
+ "allOf": [
7323
+ {
7324
+ "$ref": "#/components/schemas/PeopleAbridged"
7325
+ }
7326
+ ]
7327
+ },
7328
+ "lighting": {
7329
+ "title": "Lighting",
7330
+ "description": "Lighting to describe the lighting usage of the program. If None, no lighting will be assumed for the program.",
7331
+ "allOf": [
7332
+ {
7333
+ "$ref": "#/components/schemas/LightingAbridged"
7334
+ }
7335
+ ]
7336
+ },
7337
+ "electric_equipment": {
7338
+ "title": "Electric Equipment",
7339
+ "description": "ElectricEquipment to describe the usage of electric equipment within the program. If None, no electric equipment will be assumed.",
7340
+ "allOf": [
7341
+ {
7342
+ "$ref": "#/components/schemas/ElectricEquipmentAbridged"
7343
+ }
7344
+ ]
7345
+ },
7346
+ "gas_equipment": {
7347
+ "title": "Gas Equipment",
7348
+ "description": "GasEquipment to describe the usage of gas equipment within the program. If None, no gas equipment will be assumed.",
7349
+ "allOf": [
7350
+ {
7351
+ "$ref": "#/components/schemas/GasEquipmentAbridged"
7352
+ }
7353
+ ]
7354
+ },
7355
+ "infiltration": {
7356
+ "title": "Infiltration",
7357
+ "description": "Infiltration to describe the outdoor air leakage of the program. If None, no infiltration will be assumed for the program.",
7358
+ "allOf": [
7359
+ {
7360
+ "$ref": "#/components/schemas/InfiltrationAbridged"
7361
+ }
7362
+ ]
7363
+ },
7364
+ "ventilation": {
7365
+ "title": "Ventilation",
7366
+ "description": "Ventilation to describe the minimum outdoor air requirement of the program. If None, no ventilation requirement will be assumed.",
7367
+ "allOf": [
7368
+ {
7369
+ "$ref": "#/components/schemas/VentilationAbridged"
7370
+ }
7371
+ ]
7372
+ },
7373
+ "setpoint": {
7374
+ "title": "Setpoint",
7375
+ "description": "Setpoint object to describe the temperature and humidity setpoints of the program. If None, the ProgramType cannot be assigned to a Room that is conditioned.",
7376
+ "allOf": [
7377
+ {
7378
+ "$ref": "#/components/schemas/SetpointAbridged"
7379
+ }
7380
+ ]
7381
+ }
7382
+ },
7383
+ "required": [
7384
+ "identifier"
7385
+ ],
7386
+ "additionalProperties": false
7387
+ },
7388
+ "People": {
7389
+ "title": "People",
7390
+ "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
7391
+ "type": "object",
7392
+ "properties": {
7393
+ "identifier": {
7394
+ "title": "Identifier",
7395
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
7396
+ "maxLength": 100,
7397
+ "minLength": 1,
7398
+ "type": "string"
7399
+ },
7400
+ "people_per_area": {
7401
+ "title": "People Per Area",
7402
+ "description": "People per floor area expressed as [people/m2]",
7403
+ "minimum": 0,
7404
+ "type": "number",
7405
+ "format": "double"
7406
+ },
7407
+ "occupancy_schedule": {
7408
+ "title": "Occupancy Schedule",
7409
+ "description": "A schedule for the occupancy over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the people_per_area to yield a complete occupancy profile.",
7410
+ "anyOf": [
7411
+ {
7412
+ "$ref": "#/components/schemas/ScheduleRuleset"
7413
+ },
7414
+ {
7415
+ "$ref": "#/components/schemas/ScheduleFixedInterval"
7416
+ }
7417
+ ]
7418
+ },
7419
+ "activity_schedule": {
7420
+ "title": "Activity Schedule",
7421
+ "description": "A schedule for the activity of the occupants over the course of the year. The type of this schedule should be Power and the values of the schedule equal to the number of Watts given off by an individual person in the room.",
7422
+ "anyOf": [
7423
+ {
7424
+ "$ref": "#/components/schemas/ScheduleRuleset"
7425
+ },
7426
+ {
7427
+ "$ref": "#/components/schemas/ScheduleFixedInterval"
7428
+ }
7429
+ ]
7430
+ },
7431
+ "display_name": {
7432
+ "title": "Display Name",
7433
+ "description": "Display name of the object with no character restrictions.",
7434
+ "type": "string"
7435
+ },
7436
+ "type": {
7437
+ "title": "Type",
7438
+ "default": "People",
7439
+ "pattern": "^People$",
7440
+ "type": "string",
7441
+ "readOnly": true
7442
+ },
7443
+ "radiant_fraction": {
7444
+ "title": "Radiant Fraction",
7445
+ "description": "The radiant fraction of sensible heat released by people. The defaultvalue is 0.30.",
7446
+ "default": 0.3,
7447
+ "minimum": 0,
7448
+ "maximum": 1,
7449
+ "type": "number",
7450
+ "format": "double"
7451
+ },
7452
+ "latent_fraction": {
7453
+ "title": "Latent Fraction",
7454
+ "description": "Number for the latent fraction of heat gain due to people or an Autocalculate object.",
7455
+ "default": {
7456
+ "type": "Autocalculate"
7457
+ },
7458
+ "anyOf": [
7459
+ {
7460
+ "$ref": "#/components/schemas/Autocalculate"
7461
+ },
7462
+ {
7463
+ "type": "number",
7464
+ "minimum": 0,
7465
+ "maximum": 1,
7466
+ "format": "double"
7467
+ }
7468
+ ]
7469
+ }
7470
+ },
7471
+ "required": [
7472
+ "identifier",
7473
+ "people_per_area",
7474
+ "occupancy_schedule",
7475
+ "activity_schedule"
5483
7476
  ],
5484
7477
  "additionalProperties": false
5485
7478
  },
@@ -6134,13 +8127,13 @@
6134
8127
  "values": {
6135
8128
  "title": "Values",
6136
8129
  "description": "A list of timeseries values occuring at each timestep over the course of the simulation.",
8130
+ "minItems": 24,
8131
+ "maxItems": 527040,
6137
8132
  "type": "array",
6138
8133
  "items": {
6139
8134
  "type": "number",
6140
8135
  "format": "double"
6141
- },
6142
- "minItems": 24,
6143
- "maxItems": 527040
8136
+ }
6144
8137
  },
6145
8138
  "display_name": {
6146
8139
  "title": "Display Name",
@@ -6175,13 +8168,13 @@
6175
8168
  1,
6176
8169
  1
6177
8170
  ],
8171
+ "minItems": 2,
8172
+ "maxItems": 3,
6178
8173
  "type": "array",
6179
8174
  "items": {
6180
8175
  "type": "integer",
6181
8176
  "format": "int32"
6182
- },
6183
- "minItems": 2,
6184
- "maxItems": 3
8177
+ }
6185
8178
  },
6186
8179
  "placeholder_value": {
6187
8180
  "title": "Placeholder Value",
@@ -6203,6 +8196,103 @@
6203
8196
  ],
6204
8197
  "additionalProperties": false
6205
8198
  },
8199
+ "VentilationControlType": {
8200
+ "title": "VentilationControlType",
8201
+ "description": "An enumeration.",
8202
+ "enum": [
8203
+ "SingleZone",
8204
+ "MultiZoneWithDistribution",
8205
+ "MultiZoneWithoutDistribution"
8206
+ ],
8207
+ "type": "string"
8208
+ },
8209
+ "BuildingType": {
8210
+ "title": "BuildingType",
8211
+ "description": "An enumeration.",
8212
+ "enum": [
8213
+ "LowRise",
8214
+ "HighRise"
8215
+ ],
8216
+ "type": "string"
8217
+ },
8218
+ "VentilationSimulationControl": {
8219
+ "title": "VentilationSimulationControl",
8220
+ "description": "The global parameters used in the ventilation simulation.",
8221
+ "type": "object",
8222
+ "properties": {
8223
+ "type": {
8224
+ "title": "Type",
8225
+ "default": "VentilationSimulationControl",
8226
+ "pattern": "^VentilationSimulationControl$",
8227
+ "type": "string",
8228
+ "readOnly": true
8229
+ },
8230
+ "vent_control_type": {
8231
+ "title": "Vent Control Type",
8232
+ "description": "Text indicating type of ventilation control. Choices are: SingleZone, MultiZoneWithDistribution, MultiZoneWithoutDistribution. The MultiZone options will model air flow with the AirflowNetwork model, which is generally more accurate then the SingleZone option, but will take considerably longer to simulate, and requires defining more ventilation parameters to explicitly account for weather and building-induced pressure differences, and the leakage geometry corresponding to specific windows, doors, and surface cracks.",
8233
+ "default": "SingleZone",
8234
+ "allOf": [
8235
+ {
8236
+ "$ref": "#/components/schemas/VentilationControlType"
8237
+ }
8238
+ ]
8239
+ },
8240
+ "reference_temperature": {
8241
+ "title": "Reference Temperature",
8242
+ "description": "Reference temperature measurement in Celsius under which the surface crack data were obtained.",
8243
+ "default": 20,
8244
+ "minimum": -273.15,
8245
+ "type": "number",
8246
+ "format": "double"
8247
+ },
8248
+ "reference_pressure": {
8249
+ "title": "Reference Pressure",
8250
+ "description": "Reference barometric pressure measurement in Pascals under which the surface crack data were obtained.",
8251
+ "default": 101325,
8252
+ "minimum": 31000,
8253
+ "maximum": 120000,
8254
+ "type": "number",
8255
+ "format": "double"
8256
+ },
8257
+ "reference_humidity_ratio": {
8258
+ "title": "Reference Humidity Ratio",
8259
+ "description": "Reference humidity ratio measurement in kgWater/kgDryAir under which the surface crack data were obtained.",
8260
+ "default": 0,
8261
+ "minimum": 0,
8262
+ "type": "number",
8263
+ "format": "double"
8264
+ },
8265
+ "building_type": {
8266
+ "title": "Building Type",
8267
+ "description": "Text indicating relationship between building footprint and height used to calculate the wind pressure coefficients for exterior surfaces.Choices are: LowRise and HighRise. LowRise corresponds to rectangular building whose height is less then three times the width and length of the footprint. HighRise corresponds to a rectangular building whose height is more than three times the width and length of the footprint. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.",
8268
+ "default": "LowRise",
8269
+ "allOf": [
8270
+ {
8271
+ "$ref": "#/components/schemas/BuildingType"
8272
+ }
8273
+ ]
8274
+ },
8275
+ "long_axis_angle": {
8276
+ "title": "Long Axis Angle",
8277
+ "description": "The clockwise rotation in degrees from true North of the long axis of the building. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.",
8278
+ "default": 0,
8279
+ "minimum": 0,
8280
+ "maximum": 180,
8281
+ "type": "number",
8282
+ "format": "double"
8283
+ },
8284
+ "aspect_ratio": {
8285
+ "title": "Aspect Ratio",
8286
+ "description": "Aspect ratio of a rectangular footprint, defined as the ratio of length of the short axis divided by the length of the long axis. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.",
8287
+ "default": 1,
8288
+ "exclusiveMinimum": 0,
8289
+ "maximum": 1,
8290
+ "type": "number",
8291
+ "format": "double"
8292
+ }
8293
+ },
8294
+ "additionalProperties": false
8295
+ },
6206
8296
  "ModelEnergyProperties": {
6207
8297
  "title": "ModelEnergyProperties",
6208
8298
  "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
@@ -6273,43 +8363,95 @@
6273
8363
  "items": {
6274
8364
  "anyOf": [
6275
8365
  {
6276
- "$ref": "#/components/schemas/EnergyMaterial"
8366
+ "$ref": "#/components/schemas/EnergyMaterial"
8367
+ },
8368
+ {
8369
+ "$ref": "#/components/schemas/EnergyMaterialNoMass"
8370
+ },
8371
+ {
8372
+ "$ref": "#/components/schemas/EnergyWindowMaterialGas"
8373
+ },
8374
+ {
8375
+ "$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
8376
+ },
8377
+ {
8378
+ "$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
8379
+ },
8380
+ {
8381
+ "$ref": "#/components/schemas/EnergyWindowMaterialSimpleGlazSys"
8382
+ },
8383
+ {
8384
+ "$ref": "#/components/schemas/EnergyWindowMaterialBlind"
8385
+ },
8386
+ {
8387
+ "$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
8388
+ },
8389
+ {
8390
+ "$ref": "#/components/schemas/EnergyWindowMaterialShade"
8391
+ }
8392
+ ]
8393
+ }
8394
+ },
8395
+ "hvacs": {
8396
+ "title": "Hvacs",
8397
+ "description": "List of all unique HVAC systems in the Model.",
8398
+ "type": "array",
8399
+ "items": {
8400
+ "anyOf": [
8401
+ {
8402
+ "$ref": "#/components/schemas/IdealAirSystemAbridged"
8403
+ },
8404
+ {
8405
+ "$ref": "#/components/schemas/VAV"
8406
+ },
8407
+ {
8408
+ "$ref": "#/components/schemas/PVAV"
8409
+ },
8410
+ {
8411
+ "$ref": "#/components/schemas/PSZ"
8412
+ },
8413
+ {
8414
+ "$ref": "#/components/schemas/PTAC"
6277
8415
  },
6278
8416
  {
6279
- "$ref": "#/components/schemas/EnergyMaterialNoMass"
8417
+ "$ref": "#/components/schemas/ForcedAirFurnace"
6280
8418
  },
6281
8419
  {
6282
- "$ref": "#/components/schemas/EnergyWindowMaterialGas"
8420
+ "$ref": "#/components/schemas/FCUwithDOAS"
6283
8421
  },
6284
8422
  {
6285
- "$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
8423
+ "$ref": "#/components/schemas/WSHPwithDOAS"
6286
8424
  },
6287
8425
  {
6288
- "$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
8426
+ "$ref": "#/components/schemas/VRFwithDOAS"
6289
8427
  },
6290
8428
  {
6291
- "$ref": "#/components/schemas/EnergyWindowMaterialSimpleGlazSys"
8429
+ "$ref": "#/components/schemas/FCU"
6292
8430
  },
6293
8431
  {
6294
- "$ref": "#/components/schemas/EnergyWindowMaterialBlind"
8432
+ "$ref": "#/components/schemas/WSHP"
6295
8433
  },
6296
8434
  {
6297
- "$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
8435
+ "$ref": "#/components/schemas/VRF"
6298
8436
  },
6299
8437
  {
6300
- "$ref": "#/components/schemas/EnergyWindowMaterialShade"
8438
+ "$ref": "#/components/schemas/Baseboard"
8439
+ },
8440
+ {
8441
+ "$ref": "#/components/schemas/EvaporativeCooler"
8442
+ },
8443
+ {
8444
+ "$ref": "#/components/schemas/Residential"
8445
+ },
8446
+ {
8447
+ "$ref": "#/components/schemas/WindowAC"
8448
+ },
8449
+ {
8450
+ "$ref": "#/components/schemas/GasUnitHeater"
6301
8451
  }
6302
8452
  ]
6303
8453
  }
6304
8454
  },
6305
- "hvacs": {
6306
- "title": "Hvacs",
6307
- "description": "List of all unique HVAC systems in the Model.",
6308
- "type": "array",
6309
- "items": {
6310
- "$ref": "#/components/schemas/IdealAirSystemAbridged"
6311
- }
6312
- },
6313
8455
  "program_types": {
6314
8456
  "title": "Program Types",
6315
8457
  "description": "List of all unique ProgramTypes in the Model.",
@@ -6353,6 +8495,15 @@
6353
8495
  "items": {
6354
8496
  "$ref": "#/components/schemas/ScheduleTypeLimit"
6355
8497
  }
8498
+ },
8499
+ "ventilation_simulation_control": {
8500
+ "title": "Ventilation Simulation Control",
8501
+ "description": "An optional parameter to define the global parameters for a ventilation cooling.",
8502
+ "allOf": [
8503
+ {
8504
+ "$ref": "#/components/schemas/VentilationSimulationControl"
8505
+ }
8506
+ ]
6356
8507
  }
6357
8508
  },
6358
8509
  "additionalProperties": false
@@ -7207,13 +9358,13 @@
7207
9358
  0.01,
7208
9359
  1.0
7209
9360
  ],
9361
+ "minItems": 3,
9362
+ "maxItems": 3,
7210
9363
  "type": "array",
7211
9364
  "items": {
7212
9365
  "type": "number",
7213
9366
  "format": "double"
7214
- },
7215
- "minItems": 3,
7216
- "maxItems": 3
9367
+ }
7217
9368
  },
7218
9369
  "thickness": {
7219
9370
  "title": "Thickness",
@@ -7240,35 +9391,35 @@
7240
9391
  "front_diffuse_reflectance": {
7241
9392
  "title": "Front Diffuse Reflectance",
7242
9393
  "description": "Optional additional front diffuse reflectance as sequence of numbers (default: None).",
9394
+ "minItems": 3,
9395
+ "maxItems": 3,
7243
9396
  "type": "array",
7244
9397
  "items": {
7245
9398
  "type": "number",
7246
9399
  "format": "double"
7247
- },
7248
- "minItems": 3,
7249
- "maxItems": 3
9400
+ }
7250
9401
  },
7251
9402
  "back_diffuse_reflectance": {
7252
9403
  "title": "Back Diffuse Reflectance",
7253
9404
  "description": "Optional additional back diffuse reflectance as sequence of numbers (default: None).",
9405
+ "minItems": 3,
9406
+ "maxItems": 3,
7254
9407
  "type": "array",
7255
9408
  "items": {
7256
9409
  "type": "number",
7257
9410
  "format": "double"
7258
- },
7259
- "minItems": 3,
7260
- "maxItems": 3
9411
+ }
7261
9412
  },
7262
9413
  "diffuse_transmittance": {
7263
9414
  "title": "Diffuse Transmittance",
7264
9415
  "description": "Optional additional diffuse transmittance as sequence of numbers (default: None).",
9416
+ "minItems": 3,
9417
+ "maxItems": 3,
7265
9418
  "type": "array",
7266
9419
  "items": {
7267
9420
  "type": "number",
7268
9421
  "format": "double"
7269
- },
7270
- "minItems": 3,
7271
- "maxItems": 3
9422
+ }
7272
9423
  }
7273
9424
  },
7274
9425
  "required": [
@@ -8483,24 +10634,331 @@
8483
10634
  "description": "Identifier for a radiance modifier object for faces with an Outdoors boundary condition.",
8484
10635
  "type": "string"
8485
10636
  },
8486
- "interior_modifier": {
8487
- "title": "Interior Modifier",
8488
- "description": "Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.",
10637
+ "interior_modifier": {
10638
+ "title": "Interior Modifier",
10639
+ "description": "Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.",
10640
+ "type": "string"
10641
+ },
10642
+ "type": {
10643
+ "title": "Type",
10644
+ "default": "ShadeModifierSetAbridged",
10645
+ "pattern": "^ShadeModifierSetAbridged$",
10646
+ "type": "string",
10647
+ "readOnly": true
10648
+ }
10649
+ },
10650
+ "additionalProperties": false
10651
+ },
10652
+ "ModifierSetAbridged": {
10653
+ "title": "ModifierSetAbridged",
10654
+ "description": "Abridged set containing all modifiers needed to create a radiance model.",
10655
+ "type": "object",
10656
+ "properties": {
10657
+ "identifier": {
10658
+ "title": "Identifier",
10659
+ "description": "Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.",
10660
+ "type": "string"
10661
+ },
10662
+ "display_name": {
10663
+ "title": "Display Name",
10664
+ "description": "Display name of the object with no character restrictions.",
10665
+ "type": "string"
10666
+ },
10667
+ "type": {
10668
+ "title": "Type",
10669
+ "default": "ModifierSetAbridged",
10670
+ "pattern": "^ModifierSetAbridged$",
10671
+ "type": "string",
10672
+ "readOnly": true
10673
+ },
10674
+ "wall_set": {
10675
+ "title": "Wall Set",
10676
+ "description": "Optional WallModifierSet object for this ModifierSet (default: None).",
10677
+ "allOf": [
10678
+ {
10679
+ "$ref": "#/components/schemas/WallModifierSetAbridged"
10680
+ }
10681
+ ]
10682
+ },
10683
+ "floor_set": {
10684
+ "title": "Floor Set",
10685
+ "description": "Optional FloorModifierSet object for this ModifierSet (default: None).",
10686
+ "allOf": [
10687
+ {
10688
+ "$ref": "#/components/schemas/FloorModifierSetAbridged"
10689
+ }
10690
+ ]
10691
+ },
10692
+ "roof_ceiling_set": {
10693
+ "title": "Roof Ceiling Set",
10694
+ "description": "Optional RoofCeilingModifierSet object for this ModifierSet (default: None).",
10695
+ "allOf": [
10696
+ {
10697
+ "$ref": "#/components/schemas/RoofCeilingModifierSetAbridged"
10698
+ }
10699
+ ]
10700
+ },
10701
+ "aperture_set": {
10702
+ "title": "Aperture Set",
10703
+ "description": "Optional ApertureModifierSet object for this ModifierSet (default: None).",
10704
+ "allOf": [
10705
+ {
10706
+ "$ref": "#/components/schemas/ApertureModifierSetAbridged"
10707
+ }
10708
+ ]
10709
+ },
10710
+ "door_set": {
10711
+ "title": "Door Set",
10712
+ "description": "Optional DoorModifierSet object for this ModifierSet (default: None).",
10713
+ "allOf": [
10714
+ {
10715
+ "$ref": "#/components/schemas/DoorModifierSetAbridged"
10716
+ }
10717
+ ]
10718
+ },
10719
+ "shade_set": {
10720
+ "title": "Shade Set",
10721
+ "description": "Optional ShadeModifierSet object for this ModifierSet (default: None).",
10722
+ "allOf": [
10723
+ {
10724
+ "$ref": "#/components/schemas/ShadeModifierSetAbridged"
10725
+ }
10726
+ ]
10727
+ },
10728
+ "air_boundary_modifier": {
10729
+ "title": "Air Boundary Modifier",
10730
+ "description": "Optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.",
10731
+ "type": "string"
10732
+ }
10733
+ },
10734
+ "required": [
10735
+ "identifier"
10736
+ ],
10737
+ "additionalProperties": false
10738
+ },
10739
+ "Sensor": {
10740
+ "title": "Sensor",
10741
+ "description": "A single Radiance of sensors.",
10742
+ "type": "object",
10743
+ "properties": {
10744
+ "pos": {
10745
+ "title": "Pos",
10746
+ "description": "Position of sensor in space as an array of (x, y, z) values.",
10747
+ "minItems": 3,
10748
+ "maxItems": 3,
10749
+ "type": "array",
10750
+ "items": {
10751
+ "type": "number",
10752
+ "format": "double"
10753
+ }
10754
+ },
10755
+ "dir": {
10756
+ "title": "Dir",
10757
+ "description": "Direction of sensor as an array of (x, y, z) values.",
10758
+ "minItems": 3,
10759
+ "maxItems": 3,
10760
+ "type": "array",
10761
+ "items": {
10762
+ "type": "number",
10763
+ "format": "double"
10764
+ }
10765
+ },
10766
+ "type": {
10767
+ "title": "Type",
10768
+ "default": "Sensor",
10769
+ "pattern": "^Sensor$",
10770
+ "type": "string",
10771
+ "readOnly": true
10772
+ }
10773
+ },
10774
+ "required": [
10775
+ "pos",
10776
+ "dir"
10777
+ ],
10778
+ "additionalProperties": false
10779
+ },
10780
+ "Color": {
10781
+ "title": "Color",
10782
+ "description": "A mesh in 3D space.",
10783
+ "type": "object",
10784
+ "properties": {
10785
+ "r": {
10786
+ "title": "R",
10787
+ "description": "Integer for red value.",
10788
+ "minimum": 0,
10789
+ "maximum": 255,
10790
+ "type": "integer",
10791
+ "format": "int32"
10792
+ },
10793
+ "g": {
10794
+ "title": "G",
10795
+ "description": "Integer for green value.",
10796
+ "minimum": 0,
10797
+ "maximum": 255,
10798
+ "type": "integer",
10799
+ "format": "int32"
10800
+ },
10801
+ "b": {
10802
+ "title": "B",
10803
+ "description": "Integer for blue value.",
10804
+ "minimum": 0,
10805
+ "maximum": 255,
10806
+ "type": "integer",
10807
+ "format": "int32"
10808
+ },
10809
+ "type": {
10810
+ "title": "Type",
10811
+ "default": "Color",
10812
+ "pattern": "^Color$",
10813
+ "type": "string",
10814
+ "readOnly": true
10815
+ }
10816
+ },
10817
+ "required": [
10818
+ "r",
10819
+ "g",
10820
+ "b"
10821
+ ],
10822
+ "additionalProperties": false
10823
+ },
10824
+ "Mesh3D": {
10825
+ "title": "Mesh3D",
10826
+ "description": "A mesh in 3D space.",
10827
+ "type": "object",
10828
+ "properties": {
10829
+ "vertices": {
10830
+ "title": "Vertices",
10831
+ "description": "A list of points representing the vertices of the mesh. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.",
10832
+ "minItems": 3,
10833
+ "type": "array",
10834
+ "items": {
10835
+ "type": "array",
10836
+ "items": {
10837
+ "type": "number",
10838
+ "format": "double"
10839
+ },
10840
+ "minItems": 3,
10841
+ "maxItems": 3
10842
+ }
10843
+ },
10844
+ "faces": {
10845
+ "title": "Faces",
10846
+ "description": "A list of lists with each sub-list having either 3 or 4 integers. These integers correspond to indices within the list of vertices.",
10847
+ "minItems": 1,
10848
+ "type": "array",
10849
+ "items": {
10850
+ "type": "array",
10851
+ "items": {
10852
+ "type": "integer",
10853
+ "format": "int32"
10854
+ },
10855
+ "minItems": 3,
10856
+ "maxItems": 4
10857
+ }
10858
+ },
10859
+ "type": {
10860
+ "title": "Type",
10861
+ "default": "Mesh3D",
10862
+ "pattern": "^Mesh3D$",
10863
+ "type": "string",
10864
+ "readOnly": true
10865
+ },
10866
+ "colors": {
10867
+ "title": "Colors",
10868
+ "description": "An optional list of colors that correspond to either the faces of the mesh or the vertices of the mesh.",
10869
+ "type": "array",
10870
+ "items": {
10871
+ "$ref": "#/components/schemas/Color"
10872
+ }
10873
+ }
10874
+ },
10875
+ "required": [
10876
+ "vertices",
10877
+ "faces"
10878
+ ],
10879
+ "additionalProperties": false
10880
+ },
10881
+ "SensorGrid": {
10882
+ "title": "SensorGrid",
10883
+ "description": "A grid of sensors.",
10884
+ "type": "object",
10885
+ "properties": {
10886
+ "identifier": {
10887
+ "title": "Identifier",
10888
+ "description": "Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.",
10889
+ "type": "string"
10890
+ },
10891
+ "sensors": {
10892
+ "title": "Sensors",
10893
+ "description": "A list of sensors that belong to the grid.",
10894
+ "type": "array",
10895
+ "items": {
10896
+ "$ref": "#/components/schemas/Sensor"
10897
+ }
10898
+ },
10899
+ "display_name": {
10900
+ "title": "Display Name",
10901
+ "description": "Text string for a unique display name, used to set the default file name that the radiance asset is written to within a radiance folder. Must not contain spaces or special characters.",
10902
+ "type": "string"
10903
+ },
10904
+ "room_identifier": {
10905
+ "title": "Room Identifier",
10906
+ "description": "Optional text string for the Room identifier to which this object belongs. This will be used to narrow down the number of aperture groups that have to be run with this sensor grid. If None, the grid will be run with all aperture groups in the model.",
10907
+ "maxLength": 100,
10908
+ "minLength": 1,
10909
+ "pattern": "[A-Za-z0-9_-]",
8489
10910
  "type": "string"
8490
10911
  },
10912
+ "light_path": {
10913
+ "title": "Light Path",
10914
+ "description": "Get or set a list of lists for the light path from the object to the sky. Each sub-list contains identifiers of aperture groups through which light passes. (eg. [[\"SouthWindow1\"], [\"static_apertures\", \"NorthWindow2\"]]).Setting this property will override any auto-calculation of the light path from the model and room_identifier upon export to the simulation.",
10915
+ "type": "array",
10916
+ "items": {
10917
+ "type": "array",
10918
+ "items": {
10919
+ "type": "string"
10920
+ }
10921
+ }
10922
+ },
8491
10923
  "type": {
8492
10924
  "title": "Type",
8493
- "default": "ShadeModifierSetAbridged",
8494
- "pattern": "^ShadeModifierSetAbridged$",
10925
+ "default": "SensorGrid",
10926
+ "pattern": "^SensorGrid$",
8495
10927
  "type": "string",
8496
10928
  "readOnly": true
10929
+ },
10930
+ "mesh": {
10931
+ "title": "Mesh",
10932
+ "description": "An optional Mesh3D that aligns with the sensors and can be used for visualization of the grid. Note that the number of sensors in the grid must match the number of faces or the number vertices within the Mesh3D.",
10933
+ "allOf": [
10934
+ {
10935
+ "$ref": "#/components/schemas/Mesh3D"
10936
+ }
10937
+ ]
8497
10938
  }
8498
10939
  },
10940
+ "required": [
10941
+ "identifier",
10942
+ "sensors"
10943
+ ],
8499
10944
  "additionalProperties": false
8500
10945
  },
8501
- "ModifierSetAbridged": {
8502
- "title": "ModifierSetAbridged",
8503
- "description": "Abridged set containing all modifiers needed to create a radiance model.",
10946
+ "ViewType": {
10947
+ "title": "ViewType",
10948
+ "description": "A single character for the view type (-vt).",
10949
+ "enum": [
10950
+ "v",
10951
+ "h",
10952
+ "l",
10953
+ "c",
10954
+ "a",
10955
+ "s"
10956
+ ],
10957
+ "type": "string"
10958
+ },
10959
+ "View": {
10960
+ "title": "View",
10961
+ "description": "A single Radiance of sensors.",
8504
10962
  "type": "object",
8505
10963
  "properties": {
8506
10964
  "identifier": {
@@ -8508,80 +10966,123 @@
8508
10966
  "description": "Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.",
8509
10967
  "type": "string"
8510
10968
  },
10969
+ "position": {
10970
+ "title": "Position",
10971
+ "description": "The view position (-vp) as an array of (x, y, z) values.This is the focal point of a perspective view or the center of a parallel projection.",
10972
+ "minItems": 3,
10973
+ "maxItems": 3,
10974
+ "type": "array",
10975
+ "items": {
10976
+ "type": "number",
10977
+ "format": "double"
10978
+ }
10979
+ },
10980
+ "direction": {
10981
+ "title": "Direction",
10982
+ "description": "The view direction (-vd) as an array of (x, y, z) values.The length of this vector indicates the focal distance as needed by the pixel depth of field (-pd) in rpict.",
10983
+ "minItems": 3,
10984
+ "maxItems": 3,
10985
+ "type": "array",
10986
+ "items": {
10987
+ "type": "number",
10988
+ "format": "double"
10989
+ }
10990
+ },
10991
+ "up_vector": {
10992
+ "title": "Up Vector",
10993
+ "description": "The view up (-vu) vector as an array of (x, y, z) values.",
10994
+ "minItems": 3,
10995
+ "maxItems": 3,
10996
+ "type": "array",
10997
+ "items": {
10998
+ "type": "number",
10999
+ "format": "double"
11000
+ }
11001
+ },
8511
11002
  "display_name": {
8512
11003
  "title": "Display Name",
8513
- "description": "Display name of the object with no character restrictions.",
11004
+ "description": "Text string for a unique display name, used to set the default file name that the radiance asset is written to within a radiance folder. Must not contain spaces or special characters.",
11005
+ "type": "string"
11006
+ },
11007
+ "room_identifier": {
11008
+ "title": "Room Identifier",
11009
+ "description": "Optional text string for the Room identifier to which this object belongs. This will be used to narrow down the number of aperture groups that have to be run with this sensor grid. If None, the grid will be run with all aperture groups in the model.",
11010
+ "maxLength": 100,
11011
+ "minLength": 1,
11012
+ "pattern": "[A-Za-z0-9_-]",
8514
11013
  "type": "string"
8515
11014
  },
11015
+ "light_path": {
11016
+ "title": "Light Path",
11017
+ "description": "Get or set a list of lists for the light path from the object to the sky. Each sub-list contains identifiers of aperture groups through which light passes. (eg. [[\"SouthWindow1\"], [\"static_apertures\", \"NorthWindow2\"]]).Setting this property will override any auto-calculation of the light path from the model and room_identifier upon export to the simulation.",
11018
+ "type": "array",
11019
+ "items": {
11020
+ "type": "array",
11021
+ "items": {
11022
+ "type": "string"
11023
+ }
11024
+ }
11025
+ },
8516
11026
  "type": {
8517
11027
  "title": "Type",
8518
- "default": "ModifierSetAbridged",
8519
- "pattern": "^ModifierSetAbridged$",
11028
+ "default": "View",
11029
+ "pattern": "^View$",
8520
11030
  "type": "string",
8521
11031
  "readOnly": true
8522
11032
  },
8523
- "wall_set": {
8524
- "title": "Wall Set",
8525
- "description": "Optional WallModifierSet object for this ModifierSet (default: None).",
11033
+ "view_type": {
11034
+ "title": "View Type",
11035
+ "default": "v",
8526
11036
  "allOf": [
8527
11037
  {
8528
- "$ref": "#/components/schemas/WallModifierSetAbridged"
11038
+ "$ref": "#/components/schemas/ViewType"
8529
11039
  }
8530
11040
  ]
8531
11041
  },
8532
- "floor_set": {
8533
- "title": "Floor Set",
8534
- "description": "Optional FloorModifierSet object for this ModifierSet (default: None).",
8535
- "allOf": [
8536
- {
8537
- "$ref": "#/components/schemas/FloorModifierSetAbridged"
8538
- }
8539
- ]
11042
+ "h_size": {
11043
+ "title": "H Size",
11044
+ "description": "A number for the horizontal field of view in degrees (for all perspective projections including fisheye). For a parallel projection, this is the view width in world coordinates.",
11045
+ "default": 60,
11046
+ "type": "number",
11047
+ "format": "double"
8540
11048
  },
8541
- "roof_ceiling_set": {
8542
- "title": "Roof Ceiling Set",
8543
- "description": "Optional RoofCeilingModifierSet object for this ModifierSet (default: None).",
8544
- "allOf": [
8545
- {
8546
- "$ref": "#/components/schemas/RoofCeilingModifierSetAbridged"
8547
- }
8548
- ]
11049
+ "v_size": {
11050
+ "title": "V Size",
11051
+ "description": "A number for the vertical field of view in degrees (for all perspective projections including fisheye). For a parallel projection, this is the view width in world coordinates.",
11052
+ "default": 60,
11053
+ "type": "number",
11054
+ "format": "double"
8549
11055
  },
8550
- "aperture_set": {
8551
- "title": "Aperture Set",
8552
- "description": "Optional ApertureModifierSet object for this ModifierSet (default: None).",
8553
- "allOf": [
8554
- {
8555
- "$ref": "#/components/schemas/ApertureModifierSetAbridged"
8556
- }
8557
- ]
11056
+ "shift": {
11057
+ "title": "Shift",
11058
+ "description": "The view shift (-vs). This is the amount the actual image will be shifted to the right of the specified view. This option is useful for generating skewed perspectives or rendering an image a piece at a time. A value of 1 means that the rendered image starts just to the right of the normal view. A value of -1 would be to the left. Larger or fractional values are permitted as well.",
11059
+ "type": "number",
11060
+ "format": "double"
8558
11061
  },
8559
- "door_set": {
8560
- "title": "Door Set",
8561
- "description": "Optional DoorModifierSet object for this ModifierSet (default: None).",
8562
- "allOf": [
8563
- {
8564
- "$ref": "#/components/schemas/DoorModifierSetAbridged"
8565
- }
8566
- ]
11062
+ "lift": {
11063
+ "title": "Lift",
11064
+ "description": "The view lift (-vl). This is the amount the actual image will be lifted up from the specified view. This option is useful for generating skewed perspectives or rendering an image a piece at a time. A value of 1 means that the rendered image starts just to the right of the normal view. A value of -1 would be to the left. Larger or fractional values are permitted as well.",
11065
+ "type": "number",
11066
+ "format": "double"
8567
11067
  },
8568
- "shade_set": {
8569
- "title": "Shade Set",
8570
- "description": "Optional ShadeModifierSet object for this ModifierSet (default: None).",
8571
- "allOf": [
8572
- {
8573
- "$ref": "#/components/schemas/ShadeModifierSetAbridged"
8574
- }
8575
- ]
11068
+ "fore_clip": {
11069
+ "title": "Fore Clip",
11070
+ "description": "View fore clip (-vo) at a distance from the view point.The plane will be perpendicular to the view direction for perspective and parallel view types. For fisheye view types, the clipping plane is actually a clipping sphere, centered on the view point with fore_clip radius. Objects in front of this imaginary surface will not be visible.",
11071
+ "type": "number",
11072
+ "format": "double"
8576
11073
  },
8577
- "air_boundary_modifier": {
8578
- "title": "Air Boundary Modifier",
8579
- "description": "Optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.",
8580
- "type": "string"
11074
+ "aft_clip": {
11075
+ "title": "Aft Clip",
11076
+ "description": "View aft clip (-va) at a distance from the view point.Like the view fore plane, it will be perpendicular to the view direction for perspective and parallel view types. For fisheye view types, the clipping plane is actually a clipping sphere, centered on the view point with radius val.",
11077
+ "type": "number",
11078
+ "format": "double"
8581
11079
  }
8582
11080
  },
8583
11081
  "required": [
8584
- "identifier"
11082
+ "identifier",
11083
+ "position",
11084
+ "direction",
11085
+ "up_vector"
8585
11086
  ],
8586
11087
  "additionalProperties": false
8587
11088
  },
@@ -8599,7 +11100,7 @@
8599
11100
  },
8600
11101
  "modifiers": {
8601
11102
  "title": "Modifiers",
8602
- "description": "A list of all unique modifiers in the model. This includes modifiers across all Faces, Apertures, Doors, Shades, Room ModifierSets, and the global_modifier_set (default: None).",
11103
+ "description": "A list of all unique modifiers in the model. This includes modifiers across all Faces, Apertures, Doors, Shades, Room ModifierSets, and the global_modifier_set.",
8603
11104
  "type": "array",
8604
11105
  "items": {
8605
11106
  "anyOf": [
@@ -8635,7 +11136,7 @@
8635
11136
  },
8636
11137
  "modifier_sets": {
8637
11138
  "title": "Modifier Sets",
8638
- "description": "A list of all unique Room-Assigned ModifierSets in the Model (default: None).",
11139
+ "description": "A list of all unique Room-Assigned ModifierSets in the Model.",
8639
11140
  "type": "array",
8640
11141
  "items": {
8641
11142
  "anyOf": [
@@ -8647,6 +11148,22 @@
8647
11148
  }
8648
11149
  ]
8649
11150
  }
11151
+ },
11152
+ "sensor_grids": {
11153
+ "title": "Sensor Grids",
11154
+ "description": "An array of SensorGrids that are associated with the model.",
11155
+ "type": "array",
11156
+ "items": {
11157
+ "$ref": "#/components/schemas/SensorGrid"
11158
+ }
11159
+ },
11160
+ "views": {
11161
+ "title": "Views",
11162
+ "description": "An array of Views that are associated with the model.",
11163
+ "type": "array",
11164
+ "items": {
11165
+ "$ref": "#/components/schemas/View"
11166
+ }
8650
11167
  }
8651
11168
  },
8652
11169
  "additionalProperties": false
@@ -8712,7 +11229,7 @@
8712
11229
  "version": {
8713
11230
  "title": "Version",
8714
11231
  "description": "Text string for the current version of the schema.",
8715
- "default": "0.0.0",
11232
+ "default": "1.36.0",
8716
11233
  "pattern": "([0-9]+)\\.([0-9]+)\\.([0-9]+)",
8717
11234
  "type": "string"
8718
11235
  },
@@ -8757,15 +11274,14 @@
8757
11274
  }
8758
11275
  },
8759
11276
  "units": {
11277
+ "title": "Units",
11278
+ "description": "Text indicating the units in which the model geometry exists. This is used to scale the geometry to the correct units for simulation engines like EnergyPlus, which requires all geometry be in meters.",
11279
+ "default": "Meters",
8760
11280
  "allOf": [
8761
11281
  {
8762
11282
  "$ref": "#/components/schemas/Units"
8763
11283
  }
8764
- ],
8765
- "title": "Units",
8766
- "description": "Text indicating the units in which the model geometry exists. This is used to scale the geometry to the correct units for simulation engines like EnergyPlus, which requires all geometry be in meters.",
8767
- "default": "Meters",
8768
- "type": "string"
11284
+ ]
8769
11285
  },
8770
11286
  "tolerance": {
8771
11287
  "title": "Tolerance",
@@ -8789,131 +11305,6 @@
8789
11305
  "properties"
8790
11306
  ],
8791
11307
  "additionalProperties": false
8792
- },
8793
- "Roughness": {
8794
- "title": "Roughness",
8795
- "default": "MediumRough",
8796
- "enum": [
8797
- "VeryRough",
8798
- "Rough",
8799
- "MediumRough",
8800
- "MediumSmooth",
8801
- "Smooth",
8802
- "VerySmooth"
8803
- ],
8804
- "type": "string"
8805
- },
8806
- "SlatOrientation": {
8807
- "title": "Slat Orientation",
8808
- "default": "Horizontal",
8809
- "enum": [
8810
- "Horizontal",
8811
- "Vertical"
8812
- ],
8813
- "type": "string"
8814
- },
8815
- "GasType": {
8816
- "title": "Gas Type",
8817
- "default": "Air",
8818
- "enum": [
8819
- "Air",
8820
- "Argon",
8821
- "Krypton",
8822
- "Xenon"
8823
- ],
8824
- "type": "string"
8825
- },
8826
- "FaceType": {
8827
- "title": "Face Type",
8828
- "enum": [
8829
- "Wall",
8830
- "Floor",
8831
- "RoofCeiling",
8832
- "AirBoundary"
8833
- ],
8834
- "type": "string"
8835
- },
8836
- "EconomizerType": {
8837
- "title": "Economizer Type",
8838
- "description": "Text to indicate the type of air-side economizer used on the ideal air system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone.",
8839
- "default": "DifferentialDryBulb",
8840
- "enum": [
8841
- "NoEconomizer",
8842
- "DifferentialDryBulb",
8843
- "DifferentialEnthalpy"
8844
- ],
8845
- "type": "string"
8846
- },
8847
- "Units": {
8848
- "title": "Units",
8849
- "description": "Text indicating the units in which the model geometry exists. This is used to scale the geometry to the correct units for simulation engines like EnergyPlus, which requires all geometry be in meters.",
8850
- "default": "Meters",
8851
- "enum": [
8852
- "Meters",
8853
- "Millimeters",
8854
- "Feet",
8855
- "Inches",
8856
- "Centimeters"
8857
- ],
8858
- "type": "string"
8859
- },
8860
- "ScheduleNumericType": {
8861
- "title": "Numeric Type",
8862
- "default": "Continuous",
8863
- "enum": [
8864
- "Continuous",
8865
- "Discrete"
8866
- ],
8867
- "type": "string"
8868
- },
8869
- "ScheduleUnitType": {
8870
- "title": "Unit Type",
8871
- "default": "Dimensionless",
8872
- "enum": [
8873
- "Dimensionless",
8874
- "Temperature",
8875
- "DeltaTemperature",
8876
- "PrecipitationRate",
8877
- "Angle",
8878
- "ConvectionCoefficient",
8879
- "ActivityLevel",
8880
- "Velocity",
8881
- "Capacity",
8882
- "Power",
8883
- "Availability",
8884
- "Percent",
8885
- "Control",
8886
- "Mode"
8887
- ],
8888
- "type": "string"
8889
- },
8890
- "ShadeLocation": {
8891
- "title": "Shade Location",
8892
- "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
8893
- "default": "Interior",
8894
- "enum": [
8895
- "Interior",
8896
- "Between",
8897
- "Exterior"
8898
- ],
8899
- "type": "string"
8900
- },
8901
- "ControlType": {
8902
- "title": "Control Type",
8903
- "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
8904
- "default": "AlwaysOn",
8905
- "enum": [
8906
- "AlwaysOn",
8907
- "OnIfHighSolarOnWindow",
8908
- "OnIfHighHorizontalSolar",
8909
- "OnIfHighOutdoorAirTemperature",
8910
- "OnIfHighZoneAirTemperature",
8911
- "OnIfHighZoneCooling",
8912
- "OnNightIfLowOutdoorTempAndOffDay",
8913
- "OnNightIfLowInsideTempAndOffDay",
8914
- "OnNightIfHeatingAndOffDay"
8915
- ],
8916
- "type": "string"
8917
11308
  }
8918
11309
  }
8919
11310
  }