honeybee-openstudio 2.9.2 → 2.10.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: d7265fe2d040154eaabc62cd384a046e9de1561479f96ae6922760ae90468fdd
4
- data.tar.gz: fe64853cd2a21ec4ae349b22bf9b96bc9401411237660d7a244bf618216f4baa
3
+ metadata.gz: 280adab68823a83e822089b6d24b91437a681e24f25db7e9d6235360390c8310
4
+ data.tar.gz: 418e160d1882fd445f0413cf2ee26313b1294056bdbe0864821c2c7b7743d899
5
5
  SHA512:
6
- metadata.gz: 0a3063864e5458fe0f84ff4c244d8514d616656add8f173700a68d7dac7ab156e4b67d07ab0e204870fa9291a62a2335bf19e996153ca856868fbd1ebd39a59c
7
- data.tar.gz: 8e958117ddf00a3e26b054248601b00af820df807313a3913828365b9285090b2f8e20d1ada94cbe09c46fb6620c0edcfbc1fa2d1dc026e05d27f1da7da25966
6
+ metadata.gz: 60e1a0d247c1e9b6cb8917ead068f9565c0aa18022d5bc0360d0d2ad6094b7bef78256dfa618a52eac91879efe63edbe0ecc39017a92cde7e7da3d0c99e8cfc0
7
+ data.tar.gz: e826611904e4b1d3449c9fd81c51fd647ad0a68df221d39fbc5fddbd11f0253aaca7061447b0f81e04d8303ce250a492e471d41e6fb71060000675d237f96bf5
@@ -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.9.2'
7
+ spec.version = '2.10.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
 
@@ -72,6 +72,7 @@ require 'honeybee/load/people'
72
72
  require 'honeybee/load/lighting'
73
73
  require 'honeybee/load/electric_equipment'
74
74
  require 'honeybee/load/gas_equipment'
75
+ require 'honeybee/load/service_hot_water'
75
76
  require 'honeybee/load/infiltration'
76
77
  require 'honeybee/load/ventilation'
77
78
  require 'honeybee/load/setpoint_thermostat'
@@ -2,8 +2,8 @@
2
2
  "openapi": "3.0.2",
3
3
  "servers": [],
4
4
  "info": {
5
- "description": "This is the documentation for Honeybee model schema.",
6
- "version": "1.36.0",
5
+ "description": "Honeybee model schema.",
6
+ "version": "1.39.12",
7
7
  "title": "Honeybee Model Schema",
8
8
  "contact": {
9
9
  "name": "Ladybug Tools",
@@ -644,6 +644,16 @@
644
644
  "x-displayName": "SensorGrid",
645
645
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SensorGrid\" />\n"
646
646
  },
647
+ {
648
+ "name": "servicehotwater_model",
649
+ "x-displayName": "ServiceHotWater",
650
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ServiceHotWater\" />\n"
651
+ },
652
+ {
653
+ "name": "servicehotwaterabridged_model",
654
+ "x-displayName": "ServiceHotWaterAbridged",
655
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ServiceHotWaterAbridged\" />\n"
656
+ },
647
657
  {
648
658
  "name": "setpoint_model",
649
659
  "x-displayName": "Setpoint",
@@ -998,6 +1008,8 @@
998
1008
  "scheduleunittype_model",
999
1009
  "sensor_model",
1000
1010
  "sensorgrid_model",
1011
+ "servicehotwater_model",
1012
+ "servicehotwaterabridged_model",
1001
1013
  "setpoint_model",
1002
1014
  "setpointabridged_model",
1003
1015
  "shade_model",
@@ -1504,6 +1516,12 @@
1504
1516
  "pattern": "^Shade$",
1505
1517
  "type": "string",
1506
1518
  "readOnly": true
1519
+ },
1520
+ "is_detached": {
1521
+ "title": "Is Detached",
1522
+ "description": "Boolean to note whether this shade is detached from any of the other geometry in the model. Cases where this should be True include shade representing surrounding buildings or context. Note that this should always be False for shades assigned to parent objects.",
1523
+ "default": false,
1524
+ "type": "boolean"
1507
1525
  }
1508
1526
  },
1509
1527
  "required": [
@@ -2124,12 +2142,7 @@
2124
2142
  ]
2125
2143
  },
2126
2144
  "face_type": {
2127
- "title": "Face Type",
2128
- "allOf": [
2129
- {
2130
- "$ref": "#/components/schemas/FaceType"
2131
- }
2132
- ]
2145
+ "$ref": "#/components/schemas/FaceType"
2133
2146
  },
2134
2147
  "boundary_condition": {
2135
2148
  "title": "Boundary Condition",
@@ -2361,6 +2374,14 @@
2361
2374
  "maximum": 1,
2362
2375
  "type": "number",
2363
2376
  "format": "double"
2377
+ },
2378
+ "baseline_watts_per_area": {
2379
+ "title": "Baseline Watts Per Area",
2380
+ "description": "The baseline lighting power density in [W/m2] of floor area. This baseline is useful to track how much better the installed lights are in comparison to a standard like ASHRAE 90.1. If set to None, it will default to 11.84029 W/m2, which is that ASHRAE 90.1-2004 baseline for an office.",
2381
+ "default": 11.84029,
2382
+ "minimum": 0,
2383
+ "type": "number",
2384
+ "format": "double"
2364
2385
  }
2365
2386
  },
2366
2387
  "required": [
@@ -2516,6 +2537,78 @@
2516
2537
  ],
2517
2538
  "additionalProperties": false
2518
2539
  },
2540
+ "ServiceHotWaterAbridged": {
2541
+ "title": "ServiceHotWaterAbridged",
2542
+ "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
2543
+ "type": "object",
2544
+ "properties": {
2545
+ "identifier": {
2546
+ "title": "Identifier",
2547
+ "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).",
2548
+ "maxLength": 100,
2549
+ "minLength": 1,
2550
+ "type": "string"
2551
+ },
2552
+ "flow_per_area": {
2553
+ "title": "Flow Per Area",
2554
+ "description": "Number for the total volume flow rate of water per unit area of floor [L/h-m2].",
2555
+ "minimum": 0,
2556
+ "type": "number",
2557
+ "format": "double"
2558
+ },
2559
+ "schedule": {
2560
+ "title": "Schedule",
2561
+ "description": "Identifier of the schedule for the hot water use over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_area to yield a complete water usage profile.",
2562
+ "maxLength": 100,
2563
+ "minLength": 1,
2564
+ "type": "string"
2565
+ },
2566
+ "display_name": {
2567
+ "title": "Display Name",
2568
+ "description": "Display name of the object with no character restrictions.",
2569
+ "type": "string"
2570
+ },
2571
+ "type": {
2572
+ "title": "Type",
2573
+ "default": "ServiceHotWaterAbridged",
2574
+ "pattern": "^ServiceHotWaterAbridged$",
2575
+ "type": "string",
2576
+ "readOnly": true
2577
+ },
2578
+ "target_temperature": {
2579
+ "title": "Target Temperature",
2580
+ "description": "Number for the target temperature of water out of the tap (C). This the temperature after hot water has been mixed with cold water from the water mains. The default is 60C, which essentially assumes that the flow_per_area on this object is only for water straight out of the water heater.",
2581
+ "default": 60,
2582
+ "exclusiveMinimum": 0,
2583
+ "type": "number",
2584
+ "format": "double"
2585
+ },
2586
+ "sensible_fraction": {
2587
+ "title": "Sensible Fraction",
2588
+ "description": "A number between 0 and 1 for the fraction of the total hot water load given off as sensible heat in the zone.",
2589
+ "default": 0.2,
2590
+ "minimum": 0,
2591
+ "maximum": 1,
2592
+ "type": "number",
2593
+ "format": "double"
2594
+ },
2595
+ "latent_fraction": {
2596
+ "title": "Latent Fraction",
2597
+ "description": "A number between 0 and 1 for the fraction of the total hot water load that is latent.",
2598
+ "default": 0.05,
2599
+ "minimum": 0,
2600
+ "maximum": 1,
2601
+ "type": "number",
2602
+ "format": "double"
2603
+ }
2604
+ },
2605
+ "required": [
2606
+ "identifier",
2607
+ "flow_per_area",
2608
+ "schedule"
2609
+ ],
2610
+ "additionalProperties": false
2611
+ },
2519
2612
  "InfiltrationAbridged": {
2520
2613
  "title": "InfiltrationAbridged",
2521
2614
  "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
@@ -2762,7 +2855,7 @@
2762
2855
  },
2763
2856
  "delta_temperature": {
2764
2857
  "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.",
2858
+ "description": "A number for the temperature differential in Celsius between indoor and outdoor below which ventilation is shut off. This should usually be a positive number so that ventilation only occurs when the outdoors is cooler than the indoors. Negative numbers indicate how much hotter the outdoors can be than the indoors before ventilation is stopped.",
2766
2859
  "default": -100,
2767
2860
  "minimum": -100,
2768
2861
  "maximum": 100,
@@ -2848,6 +2941,15 @@
2848
2941
  }
2849
2942
  ]
2850
2943
  },
2944
+ "service_hot_water": {
2945
+ "title": "Service Hot Water",
2946
+ "description": "ServiceHotWater object to describe the hot water usage.",
2947
+ "allOf": [
2948
+ {
2949
+ "$ref": "#/components/schemas/ServiceHotWaterAbridged"
2950
+ }
2951
+ ]
2952
+ },
2851
2953
  "infiltration": {
2852
2954
  "title": "Infiltration",
2853
2955
  "description": "Infiltration object to to describe the outdoor air leakage.",
@@ -3366,7 +3468,7 @@
3366
3468
  "specific_heat": {
3367
3469
  "title": "Specific Heat",
3368
3470
  "description": "Specific heat of the material layer in J/(kg-K).",
3369
- "exclusiveMinimum": 0,
3471
+ "minimum": 100,
3370
3472
  "type": "number",
3371
3473
  "format": "double"
3372
3474
  },
@@ -3383,7 +3485,6 @@
3383
3485
  "readOnly": true
3384
3486
  },
3385
3487
  "roughness": {
3386
- "title": "Roughness",
3387
3488
  "default": "MediumRough",
3388
3489
  "allOf": [
3389
3490
  {
@@ -3460,7 +3561,6 @@
3460
3561
  "readOnly": true
3461
3562
  },
3462
3563
  "roughness": {
3463
- "title": "Roughness",
3464
3564
  "default": "MediumRough",
3465
3565
  "allOf": [
3466
3566
  {
@@ -3926,7 +4026,6 @@
3926
4026
  "format": "double"
3927
4027
  },
3928
4028
  "gas_type": {
3929
- "title": "Gas Type",
3930
4029
  "default": "Air",
3931
4030
  "allOf": [
3932
4031
  {
@@ -4073,16 +4172,10 @@
4073
4172
  "type": "string"
4074
4173
  },
4075
4174
  "gas_types": {
4076
- "title": "Gas Types",
4077
4175
  "description": "List of gases in the gas mixture.",
4078
4176
  "type": "array",
4079
4177
  "items": {
4080
- "title": " Gas Types",
4081
- "allOf": [
4082
- {
4083
- "$ref": "#/components/schemas/GasType"
4084
- }
4085
- ]
4178
+ "$ref": "#/components/schemas/GasType"
4086
4179
  },
4087
4180
  "minItems": 2,
4088
4181
  "maxItems": 4
@@ -4624,7 +4717,6 @@
4624
4717
  ]
4625
4718
  },
4626
4719
  "numeric_type": {
4627
- "title": "Numeric Type",
4628
4720
  "default": "Continuous",
4629
4721
  "allOf": [
4630
4722
  {
@@ -4633,7 +4725,6 @@
4633
4725
  ]
4634
4726
  },
4635
4727
  "unit_type": {
4636
- "title": "Unit Type",
4637
4728
  "default": "Dimensionless",
4638
4729
  "allOf": [
4639
4730
  {
@@ -5115,7 +5206,6 @@
5115
5206
  "readOnly": true
5116
5207
  },
5117
5208
  "shade_location": {
5118
- "title": "Shade Location",
5119
5209
  "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
5210
  "default": "Interior",
5121
5211
  "allOf": [
@@ -5125,7 +5215,6 @@
5125
5215
  ]
5126
5216
  },
5127
5217
  "control_type": {
5128
- "title": "Control Type",
5129
5218
  "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
5130
5219
  "default": "AlwaysOn",
5131
5220
  "allOf": [
@@ -5389,7 +5478,6 @@
5389
5478
  "readOnly": true
5390
5479
  },
5391
5480
  "slat_orientation": {
5392
- "title": "Slat Orientation",
5393
5481
  "default": "Horizontal",
5394
5482
  "allOf": [
5395
5483
  {
@@ -5676,7 +5764,6 @@
5676
5764
  "readOnly": true
5677
5765
  },
5678
5766
  "shade_location": {
5679
- "title": "Shade Location",
5680
5767
  "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
5768
  "default": "Interior",
5682
5769
  "allOf": [
@@ -5686,7 +5773,6 @@
5686
5773
  ]
5687
5774
  },
5688
5775
  "control_type": {
5689
- "title": "Control Type",
5690
5776
  "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
5691
5777
  "default": "AlwaysOn",
5692
5778
  "allOf": [
@@ -5771,7 +5857,6 @@
5771
5857
  "readOnly": true
5772
5858
  },
5773
5859
  "economizer_type": {
5774
- "title": "Economizer Type",
5775
5860
  "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
5861
  "default": "DifferentialDryBulb",
5777
5862
  "allOf": [
@@ -5915,25 +6000,16 @@
5915
6000
  "VAV chiller with district hot water reheat",
5916
6001
  "VAV chiller with PFP boxes",
5917
6002
  "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
6003
  "VAV air-cooled chiller with gas boiler reheat",
5922
6004
  "VAV air-cooled chiller with central air source heat pump reheat",
5923
6005
  "VAV air-cooled chiller with district hot water reheat",
5924
6006
  "VAV air-cooled chiller with PFP boxes",
5925
6007
  "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
6008
  "VAV district chilled water with gas boiler reheat",
5930
6009
  "VAV district chilled water with central air source heat pump reheat",
5931
6010
  "VAV district chilled water with district hot water reheat",
5932
6011
  "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"
6012
+ "VAV district chilled water with gas coil reheat"
5937
6013
  ],
5938
6014
  "type": "string"
5939
6015
  },
@@ -5955,7 +6031,6 @@
5955
6031
  "type": "string"
5956
6032
  },
5957
6033
  "vintage": {
5958
- "title": "Vintage",
5959
6034
  "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
6035
  "default": "90.1-2013",
5961
6036
  "allOf": [
@@ -5965,7 +6040,6 @@
5965
6040
  ]
5966
6041
  },
5967
6042
  "economizer_type": {
5968
- "title": "Economizer Type",
5969
6043
  "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
6044
  "default": "Inferred",
5971
6045
  "allOf": [
@@ -6018,7 +6092,6 @@
6018
6092
  "readOnly": true
6019
6093
  },
6020
6094
  "equipment_type": {
6021
- "title": "Equipment Type",
6022
6095
  "description": "Text for the specific type of system equipment from the VAVEquipmentType enumeration.",
6023
6096
  "default": "VAV chiller with gas boiler reheat",
6024
6097
  "allOf": [
@@ -6063,7 +6136,6 @@
6063
6136
  "type": "string"
6064
6137
  },
6065
6138
  "vintage": {
6066
- "title": "Vintage",
6067
6139
  "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
6140
  "default": "90.1-2013",
6069
6141
  "allOf": [
@@ -6073,7 +6145,6 @@
6073
6145
  ]
6074
6146
  },
6075
6147
  "economizer_type": {
6076
- "title": "Economizer Type",
6077
6148
  "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
6149
  "default": "Inferred",
6079
6150
  "allOf": [
@@ -6126,7 +6197,6 @@
6126
6197
  "readOnly": true
6127
6198
  },
6128
6199
  "equipment_type": {
6129
- "title": "Equipment Type",
6130
6200
  "description": "Text for the specific type of system equipment from the VAVEquipmentType enumeration.",
6131
6201
  "default": "PVAV with gas boiler reheat",
6132
6202
  "allOf": [
@@ -6157,7 +6227,6 @@
6157
6227
  "PSZ-AC with no heat",
6158
6228
  "PSZ-AC district chilled water with baseboard electric",
6159
6229
  "PSZ-AC district chilled water with baseboard gas boiler",
6160
- "PSZ-AC district chilled water with baseboard district hot water",
6161
6230
  "PSZ-AC district chilled water with gas unit heaters",
6162
6231
  "PSZ-AC district chilled water with electric coil",
6163
6232
  "PSZ-AC district chilled water with gas coil",
@@ -6187,7 +6256,6 @@
6187
6256
  "type": "string"
6188
6257
  },
6189
6258
  "vintage": {
6190
- "title": "Vintage",
6191
6259
  "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
6260
  "default": "90.1-2013",
6193
6261
  "allOf": [
@@ -6197,7 +6265,6 @@
6197
6265
  ]
6198
6266
  },
6199
6267
  "economizer_type": {
6200
- "title": "Economizer Type",
6201
6268
  "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
6269
  "default": "Inferred",
6203
6270
  "allOf": [
@@ -6250,7 +6317,6 @@
6250
6317
  "readOnly": true
6251
6318
  },
6252
6319
  "equipment_type": {
6253
- "title": "Equipment Type",
6254
6320
  "description": "Text for the specific type of system equipment from the PVAVEquipmentType enumeration.",
6255
6321
  "default": "PSZ-AC with baseboard electric",
6256
6322
  "allOf": [
@@ -6301,7 +6367,6 @@
6301
6367
  "type": "string"
6302
6368
  },
6303
6369
  "vintage": {
6304
- "title": "Vintage",
6305
6370
  "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
6371
  "default": "90.1-2013",
6307
6372
  "allOf": [
@@ -6311,7 +6376,6 @@
6311
6376
  ]
6312
6377
  },
6313
6378
  "economizer_type": {
6314
- "title": "Economizer Type",
6315
6379
  "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
6380
  "default": "Inferred",
6317
6381
  "allOf": [
@@ -6364,7 +6428,6 @@
6364
6428
  "readOnly": true
6365
6429
  },
6366
6430
  "equipment_type": {
6367
- "title": "Equipment Type",
6368
6431
  "description": "Text for the specific type of system equipment from the PTACEquipmentType enumeration.",
6369
6432
  "default": "PTAC with baseboard electric",
6370
6433
  "allOf": [
@@ -6405,7 +6468,6 @@
6405
6468
  "type": "string"
6406
6469
  },
6407
6470
  "vintage": {
6408
- "title": "Vintage",
6409
6471
  "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
6472
  "default": "90.1-2013",
6411
6473
  "allOf": [
@@ -6415,7 +6477,6 @@
6415
6477
  ]
6416
6478
  },
6417
6479
  "economizer_type": {
6418
- "title": "Economizer Type",
6419
6480
  "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
6481
  "default": "Inferred",
6421
6482
  "allOf": [
@@ -6468,7 +6529,6 @@
6468
6529
  "readOnly": true
6469
6530
  },
6470
6531
  "equipment_type": {
6471
- "title": "Equipment Type",
6472
6532
  "description": "Text for the specific type of system equipment from the FurnaceEquipmentType enumeration.",
6473
6533
  "default": "Forced air furnace",
6474
6534
  "allOf": [
@@ -6526,7 +6586,6 @@
6526
6586
  "type": "string"
6527
6587
  },
6528
6588
  "vintage": {
6529
- "title": "Vintage",
6530
6589
  "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
6590
  "default": "90.1-2013",
6532
6591
  "allOf": [
@@ -6579,7 +6638,6 @@
6579
6638
  "readOnly": true
6580
6639
  },
6581
6640
  "equipment_type": {
6582
- "title": "Equipment Type",
6583
6641
  "description": "Text for the specific type of system equipment from the FCUwithDOASEquipmentType enumeration.",
6584
6642
  "default": "DOAS with fan coil chiller with boiler",
6585
6643
  "allOf": [
@@ -6623,7 +6681,6 @@
6623
6681
  "type": "string"
6624
6682
  },
6625
6683
  "vintage": {
6626
- "title": "Vintage",
6627
6684
  "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
6685
  "default": "90.1-2013",
6629
6686
  "allOf": [
@@ -6676,7 +6733,6 @@
6676
6733
  "readOnly": true
6677
6734
  },
6678
6735
  "equipment_type": {
6679
- "title": "Equipment Type",
6680
6736
  "description": "Text for the specific type of system equipment from the WSHPwithDOASEquipmentType enumeration.",
6681
6737
  "default": "DOAS with water source heat pumps fluid cooler with boiler",
6682
6738
  "allOf": [
@@ -6717,7 +6773,6 @@
6717
6773
  "type": "string"
6718
6774
  },
6719
6775
  "vintage": {
6720
- "title": "Vintage",
6721
6776
  "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
6777
  "default": "90.1-2013",
6723
6778
  "allOf": [
@@ -6770,7 +6825,6 @@
6770
6825
  "readOnly": true
6771
6826
  },
6772
6827
  "equipment_type": {
6773
- "title": "Equipment Type",
6774
6828
  "description": "Text for the specific type of system equipment from the VRFwithDOASEquipmentType enumeration.",
6775
6829
  "default": "DOAS with VRF",
6776
6830
  "allOf": [
@@ -6828,7 +6882,6 @@
6828
6882
  "type": "string"
6829
6883
  },
6830
6884
  "vintage": {
6831
- "title": "Vintage",
6832
6885
  "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
6886
  "default": "90.1-2013",
6834
6887
  "allOf": [
@@ -6845,7 +6898,6 @@
6845
6898
  "readOnly": true
6846
6899
  },
6847
6900
  "equipment_type": {
6848
- "title": "Equipment Type",
6849
6901
  "description": "Text for the specific type of system equipment from the FCUEquipmentType enumeration.",
6850
6902
  "default": "Fan coil chiller with boiler",
6851
6903
  "allOf": [
@@ -6889,7 +6941,6 @@
6889
6941
  "type": "string"
6890
6942
  },
6891
6943
  "vintage": {
6892
- "title": "Vintage",
6893
6944
  "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
6945
  "default": "90.1-2013",
6895
6946
  "allOf": [
@@ -6906,7 +6957,6 @@
6906
6957
  "readOnly": true
6907
6958
  },
6908
6959
  "equipment_type": {
6909
- "title": "Equipment Type",
6910
6960
  "description": "Text for the specific type of system equipment from the WSHPEquipmentType enumeration.",
6911
6961
  "default": "Water source heat pumps fluid cooler with boiler",
6912
6962
  "allOf": [
@@ -6947,7 +6997,6 @@
6947
6997
  "type": "string"
6948
6998
  },
6949
6999
  "vintage": {
6950
- "title": "Vintage",
6951
7000
  "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
7001
  "default": "90.1-2013",
6953
7002
  "allOf": [
@@ -6964,7 +7013,6 @@
6964
7013
  "readOnly": true
6965
7014
  },
6966
7015
  "equipment_type": {
6967
- "title": "Equipment Type",
6968
7016
  "description": "Text for the specific type of system equipment from the VRFEquipmentType enumeration.",
6969
7017
  "default": "VRF",
6970
7018
  "allOf": [
@@ -7008,7 +7056,6 @@
7008
7056
  "type": "string"
7009
7057
  },
7010
7058
  "vintage": {
7011
- "title": "Vintage",
7012
7059
  "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
7060
  "default": "90.1-2013",
7014
7061
  "allOf": [
@@ -7025,7 +7072,6 @@
7025
7072
  "readOnly": true
7026
7073
  },
7027
7074
  "equipment_type": {
7028
- "title": "Equipment Type",
7029
7075
  "description": "Text for the specific type of system equipment from the BaseboardEquipmentType enumeration.",
7030
7076
  "default": "Baseboard electric",
7031
7077
  "allOf": [
@@ -7072,7 +7118,6 @@
7072
7118
  "type": "string"
7073
7119
  },
7074
7120
  "vintage": {
7075
- "title": "Vintage",
7076
7121
  "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
7122
  "default": "90.1-2013",
7078
7123
  "allOf": [
@@ -7089,7 +7134,6 @@
7089
7134
  "readOnly": true
7090
7135
  },
7091
7136
  "equipment_type": {
7092
- "title": "Equipment Type",
7093
7137
  "description": "Text for the specific type of system equipment from the EvaporativeCoolerEquipmentType enumeration.",
7094
7138
  "default": "Direct evap coolers with baseboard electric",
7095
7139
  "allOf": [
@@ -7138,7 +7182,6 @@
7138
7182
  "type": "string"
7139
7183
  },
7140
7184
  "vintage": {
7141
- "title": "Vintage",
7142
7185
  "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
7186
  "default": "90.1-2013",
7144
7187
  "allOf": [
@@ -7155,7 +7198,6 @@
7155
7198
  "readOnly": true
7156
7199
  },
7157
7200
  "equipment_type": {
7158
- "title": "Equipment Type",
7159
7201
  "description": "Text for the specific type of system equipment from the ResidentialEquipmentType enumeration.",
7160
7202
  "default": "Residential AC with baseboard electric",
7161
7203
  "allOf": [
@@ -7202,7 +7244,6 @@
7202
7244
  "type": "string"
7203
7245
  },
7204
7246
  "vintage": {
7205
- "title": "Vintage",
7206
7247
  "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
7248
  "default": "90.1-2013",
7208
7249
  "allOf": [
@@ -7219,7 +7260,6 @@
7219
7260
  "readOnly": true
7220
7261
  },
7221
7262
  "equipment_type": {
7222
- "title": "Equipment Type",
7223
7263
  "description": "Text for the specific type of system equipment from the WindowACEquipmentType enumeration.",
7224
7264
  "default": "Window AC with baseboard electric",
7225
7265
  "allOf": [
@@ -7260,7 +7300,6 @@
7260
7300
  "type": "string"
7261
7301
  },
7262
7302
  "vintage": {
7263
- "title": "Vintage",
7264
7303
  "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
7304
  "default": "90.1-2013",
7266
7305
  "allOf": [
@@ -7277,7 +7316,6 @@
7277
7316
  "readOnly": true
7278
7317
  },
7279
7318
  "equipment_type": {
7280
- "title": "Equipment Type",
7281
7319
  "description": "Text for the specific type of system equipment from the GasUnitHeaterEquipmentType enumeration.",
7282
7320
  "default": "Gas unit heaters",
7283
7321
  "allOf": [
@@ -7352,6 +7390,15 @@
7352
7390
  }
7353
7391
  ]
7354
7392
  },
7393
+ "service_hot_water": {
7394
+ "title": "Service Hot Water",
7395
+ "description": "ServiceHotWater object to describe the usage of hot water within the program. If None, no hot water will be assumed.",
7396
+ "allOf": [
7397
+ {
7398
+ "$ref": "#/components/schemas/ServiceHotWaterAbridged"
7399
+ }
7400
+ ]
7401
+ },
7355
7402
  "infiltration": {
7356
7403
  "title": "Infiltration",
7357
7404
  "description": "Infiltration to describe the outdoor air leakage of the program. If None, no infiltration will be assumed for the program.",
@@ -7545,6 +7592,14 @@
7545
7592
  "maximum": 1,
7546
7593
  "type": "number",
7547
7594
  "format": "double"
7595
+ },
7596
+ "baseline_watts_per_area": {
7597
+ "title": "Baseline Watts Per Area",
7598
+ "description": "The baseline lighting power density in [W/m2] of floor area. This baseline is useful to track how much better the installed lights are in comparison to a standard like ASHRAE 90.1. If set to None, it will default to 11.84029 W/m2, which is that ASHRAE 90.1-2004 baseline for an office.",
7599
+ "default": 11.84029,
7600
+ "minimum": 0,
7601
+ "type": "number",
7602
+ "format": "double"
7548
7603
  }
7549
7604
  },
7550
7605
  "required": [
@@ -7710,6 +7765,83 @@
7710
7765
  ],
7711
7766
  "additionalProperties": false
7712
7767
  },
7768
+ "ServiceHotWater": {
7769
+ "title": "ServiceHotWater",
7770
+ "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
7771
+ "type": "object",
7772
+ "properties": {
7773
+ "identifier": {
7774
+ "title": "Identifier",
7775
+ "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).",
7776
+ "maxLength": 100,
7777
+ "minLength": 1,
7778
+ "type": "string"
7779
+ },
7780
+ "flow_per_area": {
7781
+ "title": "Flow Per Area",
7782
+ "description": "Number for the total volume flow rate of water per unit area of floor [L/h-m2].",
7783
+ "minimum": 0,
7784
+ "type": "number",
7785
+ "format": "double"
7786
+ },
7787
+ "schedule": {
7788
+ "title": "Schedule",
7789
+ "description": "The schedule for the use of hot water over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_area to yield a complete water usage profile.",
7790
+ "anyOf": [
7791
+ {
7792
+ "$ref": "#/components/schemas/ScheduleRuleset"
7793
+ },
7794
+ {
7795
+ "$ref": "#/components/schemas/ScheduleFixedInterval"
7796
+ }
7797
+ ]
7798
+ },
7799
+ "display_name": {
7800
+ "title": "Display Name",
7801
+ "description": "Display name of the object with no character restrictions.",
7802
+ "type": "string"
7803
+ },
7804
+ "type": {
7805
+ "title": "Type",
7806
+ "default": "ServiceHotWater",
7807
+ "pattern": "^ServiceHotWater$",
7808
+ "type": "string",
7809
+ "readOnly": true
7810
+ },
7811
+ "target_temperature": {
7812
+ "title": "Target Temperature",
7813
+ "description": "Number for the target temperature of water out of the tap (C). This the temperature after hot water has been mixed with cold water from the water mains. The default is 60C, which essentially assumes that the flow_per_area on this object is only for water straight out of the water heater.",
7814
+ "default": 60,
7815
+ "exclusiveMinimum": 0,
7816
+ "type": "number",
7817
+ "format": "double"
7818
+ },
7819
+ "sensible_fraction": {
7820
+ "title": "Sensible Fraction",
7821
+ "description": "A number between 0 and 1 for the fraction of the total hot water load given off as sensible heat in the zone.",
7822
+ "default": 0.2,
7823
+ "minimum": 0,
7824
+ "maximum": 1,
7825
+ "type": "number",
7826
+ "format": "double"
7827
+ },
7828
+ "latent_fraction": {
7829
+ "title": "Latent Fraction",
7830
+ "description": "A number between 0 and 1 for the fraction of the total hot water load that is latent.",
7831
+ "default": 0.05,
7832
+ "minimum": 0,
7833
+ "maximum": 1,
7834
+ "type": "number",
7835
+ "format": "double"
7836
+ }
7837
+ },
7838
+ "required": [
7839
+ "identifier",
7840
+ "flow_per_area",
7841
+ "schedule"
7842
+ ],
7843
+ "additionalProperties": false
7844
+ },
7713
7845
  "Infiltration": {
7714
7846
  "title": "Infiltration",
7715
7847
  "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
@@ -7996,6 +8128,15 @@
7996
8128
  }
7997
8129
  ]
7998
8130
  },
8131
+ "service_hot_water": {
8132
+ "title": "Service Hot Water",
8133
+ "description": "ServiceHotWater object to describe the usage of hot water within the program. If None, no hot water will be assumed.",
8134
+ "allOf": [
8135
+ {
8136
+ "$ref": "#/components/schemas/ServiceHotWater"
8137
+ }
8138
+ ]
8139
+ },
7999
8140
  "infiltration": {
8000
8141
  "title": "Infiltration",
8001
8142
  "description": "Infiltration to describe the outdoor air leakage of the program. If None, no infiltration will be assumed for the program.",
@@ -8228,7 +8369,6 @@
8228
8369
  "readOnly": true
8229
8370
  },
8230
8371
  "vent_control_type": {
8231
- "title": "Vent Control Type",
8232
8372
  "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
8373
  "default": "SingleZone",
8234
8374
  "allOf": [
@@ -8263,7 +8403,6 @@
8263
8403
  "format": "double"
8264
8404
  },
8265
8405
  "building_type": {
8266
- "title": "Building Type",
8267
8406
  "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
8407
  "default": "LowRise",
8269
8408
  "allOf": [
@@ -11031,7 +11170,6 @@
11031
11170
  "readOnly": true
11032
11171
  },
11033
11172
  "view_type": {
11034
- "title": "View Type",
11035
11173
  "default": "v",
11036
11174
  "allOf": [
11037
11175
  {
@@ -11229,9 +11367,10 @@
11229
11367
  "version": {
11230
11368
  "title": "Version",
11231
11369
  "description": "Text string for the current version of the schema.",
11232
- "default": "1.36.0",
11370
+ "default": "1.39.12",
11233
11371
  "pattern": "([0-9]+)\\.([0-9]+)\\.([0-9]+)",
11234
- "type": "string"
11372
+ "type": "string",
11373
+ "readOnly": true
11235
11374
  },
11236
11375
  "rooms": {
11237
11376
  "title": "Rooms",
@@ -11274,7 +11413,6 @@
11274
11413
  }
11275
11414
  },
11276
11415
  "units": {
11277
- "title": "Units",
11278
11416
  "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
11417
  "default": "Meters",
11280
11418
  "allOf": [