honeybee-openstudio 2.25.3 → 2.27.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (60) hide show
  1. checksums.yaml +4 -4
  2. data/honeybee-openstudio.gemspec +1 -1
  3. data/lib/files/urbanopt_Gemfile +1 -1
  4. data/lib/from_openstudio/construction/air.rb +3 -0
  5. data/lib/from_openstudio/construction/opaque.rb +3 -0
  6. data/lib/from_openstudio/construction/shade.rb +3 -0
  7. data/lib/from_openstudio/construction/window.rb +3 -0
  8. data/lib/from_openstudio/construction_set.rb +3 -0
  9. data/lib/from_openstudio/material/opaque.rb +16 -1
  10. data/lib/from_openstudio/material/opaque_no_mass.rb +16 -1
  11. data/lib/from_openstudio/material/window_blind.rb +3 -0
  12. data/lib/from_openstudio/material/window_gas.rb +3 -0
  13. data/lib/from_openstudio/material/window_gas_custom.rb +3 -0
  14. data/lib/from_openstudio/material/window_gas_mixture.rb +3 -0
  15. data/lib/from_openstudio/material/window_glazing.rb +3 -0
  16. data/lib/from_openstudio/material/window_simpleglazsys.rb +3 -0
  17. data/lib/from_openstudio/schedule/fixed_interval.rb +3 -0
  18. data/lib/from_openstudio/schedule/ruleset.rb +3 -0
  19. data/lib/from_openstudio/schedule/type_limit.rb +3 -0
  20. data/lib/honeybee/_defaults/model.json +661 -29
  21. data/lib/honeybee/load/process.rb +42 -0
  22. data/lib/honeybee/model.rb +2 -1
  23. data/lib/honeybee/model_object.rb +32 -1
  24. data/lib/honeybee/simulation/parameter_model.rb +2 -1
  25. data/lib/honeybee.rb +1 -0
  26. data/lib/to_openstudio/construction/air.rb +3 -0
  27. data/lib/to_openstudio/construction/opaque.rb +3 -0
  28. data/lib/to_openstudio/construction/shade.rb +3 -0
  29. data/lib/to_openstudio/construction/window.rb +3 -1
  30. data/lib/to_openstudio/construction/windowshade.rb +3 -2
  31. data/lib/to_openstudio/construction_set.rb +3 -2
  32. data/lib/to_openstudio/geometry/aperture.rb +4 -0
  33. data/lib/to_openstudio/geometry/door.rb +4 -0
  34. data/lib/to_openstudio/geometry/face.rb +3 -0
  35. data/lib/to_openstudio/geometry/room.rb +12 -0
  36. data/lib/to_openstudio/geometry/shade.rb +3 -1
  37. data/lib/to_openstudio/hvac/ideal_air.rb +3 -1
  38. data/lib/to_openstudio/load/electric_equipment.rb +6 -0
  39. data/lib/to_openstudio/load/gas_equipment.rb +6 -0
  40. data/lib/to_openstudio/load/infiltration.rb +3 -1
  41. data/lib/to_openstudio/load/lighting.rb +3 -0
  42. data/lib/to_openstudio/load/people.rb +3 -0
  43. data/lib/to_openstudio/load/process.rb +100 -0
  44. data/lib/to_openstudio/load/ventilation.rb +3 -0
  45. data/lib/to_openstudio/material/opaque.rb +3 -0
  46. data/lib/to_openstudio/material/opaque_no_mass.rb +3 -1
  47. data/lib/to_openstudio/material/window_blind.rb +3 -1
  48. data/lib/to_openstudio/material/window_gas.rb +3 -1
  49. data/lib/to_openstudio/material/window_gas_custom.rb +3 -0
  50. data/lib/to_openstudio/material/window_gas_mixture.rb +3 -1
  51. data/lib/to_openstudio/material/window_glazing.rb +3 -1
  52. data/lib/to_openstudio/material/window_shade.rb +3 -1
  53. data/lib/to_openstudio/material/window_simpleglazsys.rb +3 -1
  54. data/lib/to_openstudio/model.rb +0 -3
  55. data/lib/to_openstudio/program_type.rb +3 -1
  56. data/lib/to_openstudio/schedule/fixed_interval.rb +6 -1
  57. data/lib/to_openstudio/schedule/ruleset.rb +6 -1
  58. data/lib/to_openstudio/schedule/type_limit.rb +3 -1
  59. data/lib/to_openstudio.rb +1 -0
  60. metadata +4 -2
@@ -3,7 +3,7 @@
3
3
  "servers": [],
4
4
  "info": {
5
5
  "description": "Honeybee model schema.",
6
- "version": "1.44.2",
6
+ "version": "1.46.1",
7
7
  "title": "Honeybee Model Schema",
8
8
  "contact": {
9
9
  "name": "Ladybug Tools",
@@ -329,6 +329,11 @@
329
329
  "x-displayName": "ForcedAirFurnace",
330
330
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ForcedAirFurnace\" />\n"
331
331
  },
332
+ {
333
+ "name": "fueltypes_model",
334
+ "x-displayName": "FuelTypes",
335
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FuelTypes\" />\n"
336
+ },
332
337
  {
333
338
  "name": "furnaceequipmenttype_model",
334
339
  "x-displayName": "FurnaceEquipmentType",
@@ -534,6 +539,11 @@
534
539
  "x-displayName": "Plastic",
535
540
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Plastic\" />\n"
536
541
  },
542
+ {
543
+ "name": "processabridged_model",
544
+ "x-displayName": "ProcessAbridged",
545
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ProcessAbridged\" />\n"
546
+ },
537
547
  {
538
548
  "name": "programtype_model",
539
549
  "x-displayName": "ProgramType",
@@ -609,6 +619,16 @@
609
619
  "x-displayName": "Roughness",
610
620
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Roughness\" />\n"
611
621
  },
622
+ {
623
+ "name": "shwequipmenttype_model",
624
+ "x-displayName": "SHWEquipmentType",
625
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SHWEquipmentType\" />\n"
626
+ },
627
+ {
628
+ "name": "shwsystem_model",
629
+ "x-displayName": "SHWSystem",
630
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SHWSystem\" />\n"
631
+ },
612
632
  {
613
633
  "name": "scheduleday_model",
614
634
  "x-displayName": "ScheduleDay",
@@ -975,6 +995,7 @@
975
995
  "floormodifierset_model",
976
996
  "floormodifiersetabridged_model",
977
997
  "forcedairfurnace_model",
998
+ "fueltypes_model",
978
999
  "furnaceequipmenttype_model",
979
1000
  "gasequipment_model",
980
1001
  "gasequipmentabridged_model",
@@ -1010,6 +1031,7 @@
1010
1031
  "peopleabridged_model",
1011
1032
  "plane_model",
1012
1033
  "plastic_model",
1034
+ "processabridged_model",
1013
1035
  "programtype_model",
1014
1036
  "programtypeabridged_model",
1015
1037
  "psz_model",
@@ -1054,6 +1076,8 @@
1054
1076
  "shademodifiersetabridged_model",
1055
1077
  "shadepropertiesabridged_model",
1056
1078
  "shaderadiancepropertiesabridged_model",
1079
+ "shwequipmenttype_model",
1080
+ "shwsystem_model",
1057
1081
  "slatorientation_model",
1058
1082
  "stategeometryabridged_model",
1059
1083
  "surface_model",
@@ -2269,7 +2293,7 @@
2269
2293
  },
2270
2294
  "PeopleAbridged": {
2271
2295
  "title": "PeopleAbridged",
2272
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
2296
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
2273
2297
  "type": "object",
2274
2298
  "properties": {
2275
2299
  "identifier": {
@@ -2299,6 +2323,11 @@
2299
2323
  "description": "Display name of the object with no character restrictions.",
2300
2324
  "type": "string"
2301
2325
  },
2326
+ "user_data": {
2327
+ "title": "User Data",
2328
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
2329
+ "type": "object"
2330
+ },
2302
2331
  "type": {
2303
2332
  "title": "Type",
2304
2333
  "default": "PeopleAbridged",
@@ -2350,7 +2379,7 @@
2350
2379
  },
2351
2380
  "LightingAbridged": {
2352
2381
  "title": "LightingAbridged",
2353
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
2382
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
2354
2383
  "type": "object",
2355
2384
  "properties": {
2356
2385
  "identifier": {
@@ -2380,6 +2409,11 @@
2380
2409
  "description": "Display name of the object with no character restrictions.",
2381
2410
  "type": "string"
2382
2411
  },
2412
+ "user_data": {
2413
+ "title": "User Data",
2414
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
2415
+ "type": "object"
2416
+ },
2383
2417
  "type": {
2384
2418
  "title": "Type",
2385
2419
  "default": "LightingAbridged",
@@ -2432,7 +2466,7 @@
2432
2466
  },
2433
2467
  "ElectricEquipmentAbridged": {
2434
2468
  "title": "ElectricEquipmentAbridged",
2435
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
2469
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
2436
2470
  "type": "object",
2437
2471
  "properties": {
2438
2472
  "identifier": {
@@ -2462,9 +2496,14 @@
2462
2496
  "description": "Display name of the object with no character restrictions.",
2463
2497
  "type": "string"
2464
2498
  },
2499
+ "user_data": {
2500
+ "title": "User Data",
2501
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
2502
+ "type": "object"
2503
+ },
2465
2504
  "radiant_fraction": {
2466
2505
  "title": "Radiant Fraction",
2467
- "description": "Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.",
2506
+ "description": "Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.",
2468
2507
  "default": 0,
2469
2508
  "minimum": 0,
2470
2509
  "maximum": 1,
@@ -2473,7 +2512,7 @@
2473
2512
  },
2474
2513
  "latent_fraction": {
2475
2514
  "title": "Latent Fraction",
2476
- "description": "Number for the amount of latent heat given off by electricequipment. Default value is 0.",
2515
+ "description": "Number for the amount of latent heat given off by equipment. Default value is 0.",
2477
2516
  "default": 0,
2478
2517
  "minimum": 0,
2479
2518
  "maximum": 1,
@@ -2506,7 +2545,7 @@
2506
2545
  },
2507
2546
  "GasEquipmentAbridged": {
2508
2547
  "title": "GasEquipmentAbridged",
2509
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
2548
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
2510
2549
  "type": "object",
2511
2550
  "properties": {
2512
2551
  "identifier": {
@@ -2536,9 +2575,14 @@
2536
2575
  "description": "Display name of the object with no character restrictions.",
2537
2576
  "type": "string"
2538
2577
  },
2578
+ "user_data": {
2579
+ "title": "User Data",
2580
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
2581
+ "type": "object"
2582
+ },
2539
2583
  "radiant_fraction": {
2540
2584
  "title": "Radiant Fraction",
2541
- "description": "Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.",
2585
+ "description": "Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.",
2542
2586
  "default": 0,
2543
2587
  "minimum": 0,
2544
2588
  "maximum": 1,
@@ -2547,7 +2591,7 @@
2547
2591
  },
2548
2592
  "latent_fraction": {
2549
2593
  "title": "Latent Fraction",
2550
- "description": "Number for the amount of latent heat given off by electricequipment. Default value is 0.",
2594
+ "description": "Number for the amount of latent heat given off by equipment. Default value is 0.",
2551
2595
  "default": 0,
2552
2596
  "minimum": 0,
2553
2597
  "maximum": 1,
@@ -2580,7 +2624,7 @@
2580
2624
  },
2581
2625
  "ServiceHotWaterAbridged": {
2582
2626
  "title": "ServiceHotWaterAbridged",
2583
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
2627
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
2584
2628
  "type": "object",
2585
2629
  "properties": {
2586
2630
  "identifier": {
@@ -2610,6 +2654,11 @@
2610
2654
  "description": "Display name of the object with no character restrictions.",
2611
2655
  "type": "string"
2612
2656
  },
2657
+ "user_data": {
2658
+ "title": "User Data",
2659
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
2660
+ "type": "object"
2661
+ },
2613
2662
  "type": {
2614
2663
  "title": "Type",
2615
2664
  "default": "ServiceHotWaterAbridged",
@@ -2653,7 +2702,7 @@
2653
2702
  },
2654
2703
  "InfiltrationAbridged": {
2655
2704
  "title": "InfiltrationAbridged",
2656
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
2705
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
2657
2706
  "type": "object",
2658
2707
  "properties": {
2659
2708
  "identifier": {
@@ -2683,6 +2732,11 @@
2683
2732
  "description": "Display name of the object with no character restrictions.",
2684
2733
  "type": "string"
2685
2734
  },
2735
+ "user_data": {
2736
+ "title": "User Data",
2737
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
2738
+ "type": "object"
2739
+ },
2686
2740
  "type": {
2687
2741
  "title": "Type",
2688
2742
  "default": "InfiltrationAbridged",
@@ -2721,7 +2775,7 @@
2721
2775
  },
2722
2776
  "VentilationAbridged": {
2723
2777
  "title": "VentilationAbridged",
2724
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
2778
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
2725
2779
  "type": "object",
2726
2780
  "properties": {
2727
2781
  "identifier": {
@@ -2737,6 +2791,11 @@
2737
2791
  "description": "Display name of the object with no character restrictions.",
2738
2792
  "type": "string"
2739
2793
  },
2794
+ "user_data": {
2795
+ "title": "User Data",
2796
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
2797
+ "type": "object"
2798
+ },
2740
2799
  "type": {
2741
2800
  "title": "Type",
2742
2801
  "default": "VentilationAbridged",
@@ -2821,6 +2880,11 @@
2821
2880
  "description": "Display name of the object with no character restrictions.",
2822
2881
  "type": "string"
2823
2882
  },
2883
+ "user_data": {
2884
+ "title": "User Data",
2885
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
2886
+ "type": "object"
2887
+ },
2824
2888
  "type": {
2825
2889
  "title": "Type",
2826
2890
  "default": "SetpointAbridged",
@@ -2989,7 +3053,7 @@
2989
3053
  },
2990
3054
  "InternalMassAbridged": {
2991
3055
  "title": "InternalMassAbridged",
2992
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
3056
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
2993
3057
  "type": "object",
2994
3058
  "properties": {
2995
3059
  "identifier": {
@@ -3019,6 +3083,11 @@
3019
3083
  "description": "Display name of the object with no character restrictions.",
3020
3084
  "type": "string"
3021
3085
  },
3086
+ "user_data": {
3087
+ "title": "User Data",
3088
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
3089
+ "type": "object"
3090
+ },
3022
3091
  "type": {
3023
3092
  "title": "Type",
3024
3093
  "default": "InternalMassAbridged",
@@ -3034,6 +3103,123 @@
3034
3103
  ],
3035
3104
  "additionalProperties": false
3036
3105
  },
3106
+ "FuelTypes": {
3107
+ "title": "FuelTypes",
3108
+ "description": "Designates the acceptable fuel types for process loads.",
3109
+ "enum": [
3110
+ "Electricity",
3111
+ "NaturalGas",
3112
+ "Propane",
3113
+ "FuelOilNo1",
3114
+ "FuelOilNo2",
3115
+ "Diesel",
3116
+ "Gasoline",
3117
+ "Coal",
3118
+ "Steam",
3119
+ "DistrictHeating",
3120
+ "DistrictCooling",
3121
+ "OtherFuel1",
3122
+ "OtherFuel2",
3123
+ "None"
3124
+ ],
3125
+ "type": "string"
3126
+ },
3127
+ "ProcessAbridged": {
3128
+ "title": "ProcessAbridged",
3129
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
3130
+ "type": "object",
3131
+ "properties": {
3132
+ "identifier": {
3133
+ "title": "Identifier",
3134
+ "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).",
3135
+ "maxLength": 100,
3136
+ "minLength": 1,
3137
+ "pattern": "^[^,;!\\n\\t]+$",
3138
+ "type": "string"
3139
+ },
3140
+ "watts": {
3141
+ "title": "Watts",
3142
+ "description": "A number for the process load power in Watts.",
3143
+ "minimum": 0,
3144
+ "type": "number",
3145
+ "format": "double"
3146
+ },
3147
+ "schedule": {
3148
+ "title": "Schedule",
3149
+ "description": "Identifier of the schedule for the use of the process over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts to yield a complete equipment profile.",
3150
+ "maxLength": 100,
3151
+ "minLength": 1,
3152
+ "type": "string"
3153
+ },
3154
+ "fuel_type": {
3155
+ "description": "Text to denote the type of fuel consumed by the process. Using the \"None\" type indicates that no end uses will be associated with the process, only the zone gains.",
3156
+ "allOf": [
3157
+ {
3158
+ "$ref": "#/components/schemas/FuelTypes"
3159
+ }
3160
+ ]
3161
+ },
3162
+ "display_name": {
3163
+ "title": "Display Name",
3164
+ "description": "Display name of the object with no character restrictions.",
3165
+ "type": "string"
3166
+ },
3167
+ "user_data": {
3168
+ "title": "User Data",
3169
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
3170
+ "type": "object"
3171
+ },
3172
+ "type": {
3173
+ "title": "Type",
3174
+ "default": "ProcessAbridged",
3175
+ "pattern": "^ProcessAbridged$",
3176
+ "type": "string",
3177
+ "readOnly": true
3178
+ },
3179
+ "end_use_category": {
3180
+ "title": "End Use Category",
3181
+ "description": "Text to indicate the end-use subcategory, which will identify the process load in the end use output. For example, \u201cCooking\u201d, \u201cClothes Drying\u201d, etc. A new meter for reporting is created for each unique subcategory.",
3182
+ "default": "Process",
3183
+ "maxLength": 100,
3184
+ "minLength": 1,
3185
+ "type": "string"
3186
+ },
3187
+ "radiant_fraction": {
3188
+ "title": "Radiant Fraction",
3189
+ "description": "Number for the amount of long-wave radiation heat given off by the process load. Default value is 0.",
3190
+ "default": 0,
3191
+ "minimum": 0,
3192
+ "maximum": 1,
3193
+ "type": "number",
3194
+ "format": "double"
3195
+ },
3196
+ "latent_fraction": {
3197
+ "title": "Latent Fraction",
3198
+ "description": "Number for the amount of latent heat given off by the process load. Default value is 0.",
3199
+ "default": 0,
3200
+ "minimum": 0,
3201
+ "maximum": 1,
3202
+ "type": "number",
3203
+ "format": "double"
3204
+ },
3205
+ "lost_fraction": {
3206
+ "title": "Lost Fraction",
3207
+ "description": "Number for the amount of \u201clost\u201d heat being given off by the process load. The default value is 0.",
3208
+ "default": 0,
3209
+ "minimum": 0,
3210
+ "maximum": 1,
3211
+ "type": "number",
3212
+ "format": "double"
3213
+ }
3214
+ },
3215
+ "required": [
3216
+ "identifier",
3217
+ "watts",
3218
+ "schedule",
3219
+ "fuel_type"
3220
+ ],
3221
+ "additionalProperties": false
3222
+ },
3037
3223
  "RoomEnergyPropertiesAbridged": {
3038
3224
  "title": "RoomEnergyPropertiesAbridged",
3039
3225
  "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.",
@@ -3067,6 +3253,13 @@
3067
3253
  "minLength": 1,
3068
3254
  "type": "string"
3069
3255
  },
3256
+ "shw": {
3257
+ "title": "Shw",
3258
+ "description": "An optional identifier of a Service Hot Water (SHW) system that specifies how the hot water load of the Room is met. If None, the hot water load will be met with a generic system that only measures thermal loadand does not account for system efficiencies.",
3259
+ "maxLength": 100,
3260
+ "minLength": 1,
3261
+ "type": "string"
3262
+ },
3070
3263
  "people": {
3071
3264
  "title": "People",
3072
3265
  "description": "People object to describe the occupancy of the Room.",
@@ -3164,6 +3357,14 @@
3164
3357
  "items": {
3165
3358
  "$ref": "#/components/schemas/InternalMassAbridged"
3166
3359
  }
3360
+ },
3361
+ "process_loads": {
3362
+ "title": "Process Loads",
3363
+ "description": "An optional list of of Process objects for process loads within the room. These can represent kilns, manufacturing equipment, and various industrial processes. They can also be used to represent wood burning fireplaces or certain pieces of equipment to be separated from the other end uses.",
3364
+ "type": "array",
3365
+ "items": {
3366
+ "$ref": "#/components/schemas/ProcessAbridged"
3367
+ }
3167
3368
  }
3168
3369
  },
3169
3370
  "additionalProperties": false
@@ -3367,6 +3568,11 @@
3367
3568
  "description": "Display name of the object with no character restrictions.",
3368
3569
  "type": "string"
3369
3570
  },
3571
+ "user_data": {
3572
+ "title": "User Data",
3573
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
3574
+ "type": "object"
3575
+ },
3370
3576
  "type": {
3371
3577
  "title": "Type",
3372
3578
  "default": "EnergyMaterial",
@@ -3444,6 +3650,11 @@
3444
3650
  "description": "Display name of the object with no character restrictions.",
3445
3651
  "type": "string"
3446
3652
  },
3653
+ "user_data": {
3654
+ "title": "User Data",
3655
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
3656
+ "type": "object"
3657
+ },
3447
3658
  "type": {
3448
3659
  "title": "Type",
3449
3660
  "default": "EnergyMaterialNoMass",
@@ -3511,6 +3722,11 @@
3511
3722
  "description": "Display name of the object with no character restrictions.",
3512
3723
  "type": "string"
3513
3724
  },
3725
+ "user_data": {
3726
+ "title": "User Data",
3727
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
3728
+ "type": "object"
3729
+ },
3514
3730
  "type": {
3515
3731
  "title": "Type",
3516
3732
  "default": "EnergyWindowMaterialGlazing",
@@ -3679,6 +3895,11 @@
3679
3895
  "description": "Display name of the object with no character restrictions.",
3680
3896
  "type": "string"
3681
3897
  },
3898
+ "user_data": {
3899
+ "title": "User Data",
3900
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
3901
+ "type": "object"
3902
+ },
3682
3903
  "type": {
3683
3904
  "title": "Type",
3684
3905
  "default": "EnergyWindowMaterialGas",
@@ -3738,6 +3959,11 @@
3738
3959
  "description": "Display name of the object with no character restrictions.",
3739
3960
  "type": "string"
3740
3961
  },
3962
+ "user_data": {
3963
+ "title": "User Data",
3964
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
3965
+ "type": "object"
3966
+ },
3741
3967
  "type": {
3742
3968
  "title": "Type",
3743
3969
  "default": "OpaqueConstructionAbridged",
@@ -3782,6 +4008,11 @@
3782
4008
  "description": "Display name of the object with no character restrictions.",
3783
4009
  "type": "string"
3784
4010
  },
4011
+ "user_data": {
4012
+ "title": "User Data",
4013
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
4014
+ "type": "object"
4015
+ },
3785
4016
  "type": {
3786
4017
  "title": "Type",
3787
4018
  "default": "WindowConstructionAbridged",
@@ -3814,6 +4045,11 @@
3814
4045
  "description": "Display name of the object with no character restrictions.",
3815
4046
  "type": "string"
3816
4047
  },
4048
+ "user_data": {
4049
+ "title": "User Data",
4050
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
4051
+ "type": "object"
4052
+ },
3817
4053
  "type": {
3818
4054
  "title": "Type",
3819
4055
  "default": "ShadeConstruction",
@@ -3869,6 +4105,11 @@
3869
4105
  "description": "Display name of the object with no character restrictions.",
3870
4106
  "type": "string"
3871
4107
  },
4108
+ "user_data": {
4109
+ "title": "User Data",
4110
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
4111
+ "type": "object"
4112
+ },
3872
4113
  "type": {
3873
4114
  "title": "Type",
3874
4115
  "default": "AirBoundaryConstructionAbridged",
@@ -4117,6 +4358,7 @@
4117
4358
  {
4118
4359
  "identifier": "Generic Roof Membrane",
4119
4360
  "display_name": null,
4361
+ "user_data": null,
4120
4362
  "type": "EnergyMaterial",
4121
4363
  "roughness": "MediumRough",
4122
4364
  "thickness": 0.01,
@@ -4130,6 +4372,7 @@
4130
4372
  {
4131
4373
  "identifier": "Generic Acoustic Tile",
4132
4374
  "display_name": null,
4375
+ "user_data": null,
4133
4376
  "type": "EnergyMaterial",
4134
4377
  "roughness": "MediumSmooth",
4135
4378
  "thickness": 0.02,
@@ -4143,6 +4386,7 @@
4143
4386
  {
4144
4387
  "identifier": "Generic 25mm Wood",
4145
4388
  "display_name": null,
4389
+ "user_data": null,
4146
4390
  "type": "EnergyMaterial",
4147
4391
  "roughness": "MediumSmooth",
4148
4392
  "thickness": 0.0254,
@@ -4156,6 +4400,7 @@
4156
4400
  {
4157
4401
  "identifier": "Generic HW Concrete",
4158
4402
  "display_name": null,
4403
+ "user_data": null,
4159
4404
  "type": "EnergyMaterial",
4160
4405
  "roughness": "MediumRough",
4161
4406
  "thickness": 0.2,
@@ -4169,6 +4414,7 @@
4169
4414
  {
4170
4415
  "identifier": "Generic Window Air Gap",
4171
4416
  "display_name": null,
4417
+ "user_data": null,
4172
4418
  "type": "EnergyWindowMaterialGas",
4173
4419
  "thickness": 0.0127,
4174
4420
  "gas_type": "Air"
@@ -4176,6 +4422,7 @@
4176
4422
  {
4177
4423
  "identifier": "Generic Gypsum Board",
4178
4424
  "display_name": null,
4425
+ "user_data": null,
4179
4426
  "type": "EnergyMaterial",
4180
4427
  "roughness": "MediumSmooth",
4181
4428
  "thickness": 0.0127,
@@ -4189,6 +4436,7 @@
4189
4436
  {
4190
4437
  "identifier": "Generic Wall Air Gap",
4191
4438
  "display_name": null,
4439
+ "user_data": null,
4192
4440
  "type": "EnergyMaterial",
4193
4441
  "roughness": "Smooth",
4194
4442
  "thickness": 0.1,
@@ -4202,6 +4450,7 @@
4202
4450
  {
4203
4451
  "identifier": "Generic Ceiling Air Gap",
4204
4452
  "display_name": null,
4453
+ "user_data": null,
4205
4454
  "type": "EnergyMaterial",
4206
4455
  "roughness": "Smooth",
4207
4456
  "thickness": 0.1,
@@ -4215,6 +4464,7 @@
4215
4464
  {
4216
4465
  "identifier": "Generic Brick",
4217
4466
  "display_name": null,
4467
+ "user_data": null,
4218
4468
  "type": "EnergyMaterial",
4219
4469
  "roughness": "MediumRough",
4220
4470
  "thickness": 0.1,
@@ -4228,6 +4478,7 @@
4228
4478
  {
4229
4479
  "identifier": "Generic 50mm Insulation",
4230
4480
  "display_name": null,
4481
+ "user_data": null,
4231
4482
  "type": "EnergyMaterial",
4232
4483
  "roughness": "MediumRough",
4233
4484
  "thickness": 0.05,
@@ -4241,6 +4492,7 @@
4241
4492
  {
4242
4493
  "identifier": "Generic Low-e Glass",
4243
4494
  "display_name": null,
4495
+ "user_data": null,
4244
4496
  "type": "EnergyWindowMaterialGlazing",
4245
4497
  "thickness": 0.006,
4246
4498
  "solar_transmittance": 0.45,
@@ -4259,6 +4511,7 @@
4259
4511
  {
4260
4512
  "identifier": "Generic Painted Metal",
4261
4513
  "display_name": null,
4514
+ "user_data": null,
4262
4515
  "type": "EnergyMaterial",
4263
4516
  "roughness": "Smooth",
4264
4517
  "thickness": 0.0015,
@@ -4272,6 +4525,7 @@
4272
4525
  {
4273
4526
  "identifier": "Generic LW Concrete",
4274
4527
  "display_name": null,
4528
+ "user_data": null,
4275
4529
  "type": "EnergyMaterial",
4276
4530
  "roughness": "MediumRough",
4277
4531
  "thickness": 0.1,
@@ -4285,6 +4539,7 @@
4285
4539
  {
4286
4540
  "identifier": "Generic 25mm Insulation",
4287
4541
  "display_name": null,
4542
+ "user_data": null,
4288
4543
  "type": "EnergyMaterial",
4289
4544
  "roughness": "MediumRough",
4290
4545
  "thickness": 0.05,
@@ -4298,6 +4553,7 @@
4298
4553
  {
4299
4554
  "identifier": "Generic Clear Glass",
4300
4555
  "display_name": null,
4556
+ "user_data": null,
4301
4557
  "type": "EnergyWindowMaterialGlazing",
4302
4558
  "thickness": 0.006,
4303
4559
  "solar_transmittance": 0.77,
@@ -4340,6 +4596,7 @@
4340
4596
  {
4341
4597
  "identifier": "Generic Interior Door",
4342
4598
  "display_name": null,
4599
+ "user_data": null,
4343
4600
  "type": "OpaqueConstructionAbridged",
4344
4601
  "materials": [
4345
4602
  "Generic 25mm Wood"
@@ -4348,6 +4605,7 @@
4348
4605
  {
4349
4606
  "identifier": "Generic Single Pane",
4350
4607
  "display_name": null,
4608
+ "user_data": null,
4351
4609
  "type": "WindowConstructionAbridged",
4352
4610
  "materials": [
4353
4611
  "Generic Clear Glass"
@@ -4356,6 +4614,7 @@
4356
4614
  {
4357
4615
  "identifier": "Generic Shade",
4358
4616
  "display_name": null,
4617
+ "user_data": null,
4359
4618
  "type": "ShadeConstruction",
4360
4619
  "solar_reflectance": 0.35,
4361
4620
  "visible_reflectance": 0.35,
@@ -4364,6 +4623,7 @@
4364
4623
  {
4365
4624
  "identifier": "Generic Interior Ceiling",
4366
4625
  "display_name": null,
4626
+ "user_data": null,
4367
4627
  "type": "OpaqueConstructionAbridged",
4368
4628
  "materials": [
4369
4629
  "Generic LW Concrete",
@@ -4374,6 +4634,7 @@
4374
4634
  {
4375
4635
  "identifier": "Generic Interior Wall",
4376
4636
  "display_name": null,
4637
+ "user_data": null,
4377
4638
  "type": "OpaqueConstructionAbridged",
4378
4639
  "materials": [
4379
4640
  "Generic Gypsum Board",
@@ -4384,6 +4645,7 @@
4384
4645
  {
4385
4646
  "identifier": "Generic Exposed Floor",
4386
4647
  "display_name": null,
4648
+ "user_data": null,
4387
4649
  "type": "OpaqueConstructionAbridged",
4388
4650
  "materials": [
4389
4651
  "Generic Painted Metal",
@@ -4395,6 +4657,7 @@
4395
4657
  {
4396
4658
  "identifier": "Generic Interior Floor",
4397
4659
  "display_name": null,
4660
+ "user_data": null,
4398
4661
  "type": "OpaqueConstructionAbridged",
4399
4662
  "materials": [
4400
4663
  "Generic Acoustic Tile",
@@ -4405,6 +4668,7 @@
4405
4668
  {
4406
4669
  "identifier": "Generic Ground Slab",
4407
4670
  "display_name": null,
4671
+ "user_data": null,
4408
4672
  "type": "OpaqueConstructionAbridged",
4409
4673
  "materials": [
4410
4674
  "Generic 50mm Insulation",
@@ -4414,6 +4678,7 @@
4414
4678
  {
4415
4679
  "identifier": "Generic Roof",
4416
4680
  "display_name": null,
4681
+ "user_data": null,
4417
4682
  "type": "OpaqueConstructionAbridged",
4418
4683
  "materials": [
4419
4684
  "Generic Roof Membrane",
@@ -4426,6 +4691,7 @@
4426
4691
  {
4427
4692
  "identifier": "Generic Exterior Wall",
4428
4693
  "display_name": null,
4694
+ "user_data": null,
4429
4695
  "type": "OpaqueConstructionAbridged",
4430
4696
  "materials": [
4431
4697
  "Generic Brick",
@@ -4438,6 +4704,7 @@
4438
4704
  {
4439
4705
  "identifier": "Generic Underground Wall",
4440
4706
  "display_name": null,
4707
+ "user_data": null,
4441
4708
  "type": "OpaqueConstructionAbridged",
4442
4709
  "materials": [
4443
4710
  "Generic 50mm Insulation",
@@ -4449,6 +4716,7 @@
4449
4716
  {
4450
4717
  "identifier": "Generic Air Boundary",
4451
4718
  "display_name": null,
4719
+ "user_data": null,
4452
4720
  "type": "AirBoundaryConstructionAbridged",
4453
4721
  "air_mixing_per_area": 0.1,
4454
4722
  "air_mixing_schedule": "Always On"
@@ -4456,6 +4724,7 @@
4456
4724
  {
4457
4725
  "identifier": "Generic Underground Roof",
4458
4726
  "display_name": null,
4727
+ "user_data": null,
4459
4728
  "type": "OpaqueConstructionAbridged",
4460
4729
  "materials": [
4461
4730
  "Generic 50mm Insulation",
@@ -4467,6 +4736,7 @@
4467
4736
  {
4468
4737
  "identifier": "Generic Double Pane",
4469
4738
  "display_name": null,
4739
+ "user_data": null,
4470
4740
  "type": "WindowConstructionAbridged",
4471
4741
  "materials": [
4472
4742
  "Generic Low-e Glass",
@@ -4477,6 +4747,7 @@
4477
4747
  {
4478
4748
  "identifier": "Generic Exterior Door",
4479
4749
  "display_name": null,
4750
+ "user_data": null,
4480
4751
  "type": "OpaqueConstructionAbridged",
4481
4752
  "materials": [
4482
4753
  "Generic Painted Metal",
@@ -4622,6 +4893,11 @@
4622
4893
  "description": "Display name of the object with no character restrictions.",
4623
4894
  "type": "string"
4624
4895
  },
4896
+ "user_data": {
4897
+ "title": "User Data",
4898
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
4899
+ "type": "object"
4900
+ },
4625
4901
  "type": {
4626
4902
  "title": "Type",
4627
4903
  "default": "ConstructionSetAbridged",
@@ -4729,6 +5005,11 @@
4729
5005
  "description": "Display name of the object with no character restrictions.",
4730
5006
  "type": "string"
4731
5007
  },
5008
+ "user_data": {
5009
+ "title": "User Data",
5010
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
5011
+ "type": "object"
5012
+ },
4732
5013
  "type": {
4733
5014
  "title": "Type",
4734
5015
  "default": "OpaqueConstruction",
@@ -4903,6 +5184,11 @@
4903
5184
  "description": "Display name of the object with no character restrictions.",
4904
5185
  "type": "string"
4905
5186
  },
5187
+ "user_data": {
5188
+ "title": "User Data",
5189
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
5190
+ "type": "object"
5191
+ },
4906
5192
  "type": {
4907
5193
  "title": "Type",
4908
5194
  "default": "EnergyWindowMaterialSimpleGlazSys",
@@ -4980,6 +5266,11 @@
4980
5266
  "description": "Display name of the object with no character restrictions.",
4981
5267
  "type": "string"
4982
5268
  },
5269
+ "user_data": {
5270
+ "title": "User Data",
5271
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
5272
+ "type": "object"
5273
+ },
4983
5274
  "type": {
4984
5275
  "title": "Type",
4985
5276
  "default": "EnergyWindowMaterialGasCustom",
@@ -5088,6 +5379,11 @@
5088
5379
  "description": "Display name of the object with no character restrictions.",
5089
5380
  "type": "string"
5090
5381
  },
5382
+ "user_data": {
5383
+ "title": "User Data",
5384
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
5385
+ "type": "object"
5386
+ },
5091
5387
  "type": {
5092
5388
  "title": "Type",
5093
5389
  "default": "EnergyWindowMaterialGasMixture",
@@ -5155,6 +5451,11 @@
5155
5451
  "description": "Display name of the object with no character restrictions.",
5156
5452
  "type": "string"
5157
5453
  },
5454
+ "user_data": {
5455
+ "title": "User Data",
5456
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
5457
+ "type": "object"
5458
+ },
5158
5459
  "type": {
5159
5460
  "title": "Type",
5160
5461
  "default": "WindowConstruction",
@@ -5187,6 +5488,11 @@
5187
5488
  "description": "Display name of the object with no character restrictions.",
5188
5489
  "type": "string"
5189
5490
  },
5491
+ "user_data": {
5492
+ "title": "User Data",
5493
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
5494
+ "type": "object"
5495
+ },
5190
5496
  "type": {
5191
5497
  "title": "Type",
5192
5498
  "default": "EnergyWindowMaterialShade",
@@ -5351,6 +5657,11 @@
5351
5657
  "description": "Display name of the object with no character restrictions.",
5352
5658
  "type": "string"
5353
5659
  },
5660
+ "user_data": {
5661
+ "title": "User Data",
5662
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
5663
+ "type": "object"
5664
+ },
5354
5665
  "type": {
5355
5666
  "title": "Type",
5356
5667
  "default": "EnergyWindowMaterialBlind",
@@ -5941,6 +6252,11 @@
5941
6252
  "description": "Display name of the object with no character restrictions.",
5942
6253
  "type": "string"
5943
6254
  },
6255
+ "user_data": {
6256
+ "title": "User Data",
6257
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
6258
+ "type": "object"
6259
+ },
5944
6260
  "type": {
5945
6261
  "title": "Type",
5946
6262
  "default": "ScheduleRuleset",
@@ -6023,6 +6339,11 @@
6023
6339
  "description": "Display name of the object with no character restrictions.",
6024
6340
  "type": "string"
6025
6341
  },
6342
+ "user_data": {
6343
+ "title": "User Data",
6344
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
6345
+ "type": "object"
6346
+ },
6026
6347
  "type": {
6027
6348
  "title": "Type",
6028
6349
  "default": "ScheduleFixedInterval",
@@ -6123,6 +6444,11 @@
6123
6444
  "description": "Display name of the object with no character restrictions.",
6124
6445
  "type": "string"
6125
6446
  },
6447
+ "user_data": {
6448
+ "title": "User Data",
6449
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
6450
+ "type": "object"
6451
+ },
6126
6452
  "type": {
6127
6453
  "title": "Type",
6128
6454
  "default": "WindowConstructionShade",
@@ -6212,6 +6538,11 @@
6212
6538
  "description": "Display name of the object with no character restrictions.",
6213
6539
  "type": "string"
6214
6540
  },
6541
+ "user_data": {
6542
+ "title": "User Data",
6543
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
6544
+ "type": "object"
6545
+ },
6215
6546
  "type": {
6216
6547
  "title": "Type",
6217
6548
  "default": "WindowConstructionDynamic",
@@ -6392,6 +6723,11 @@
6392
6723
  "description": "Display name of the object with no character restrictions.",
6393
6724
  "type": "string"
6394
6725
  },
6726
+ "user_data": {
6727
+ "title": "User Data",
6728
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
6729
+ "type": "object"
6730
+ },
6395
6731
  "type": {
6396
6732
  "title": "Type",
6397
6733
  "default": "AirBoundaryConstruction",
@@ -6443,6 +6779,11 @@
6443
6779
  "description": "Display name of the object with no character restrictions.",
6444
6780
  "type": "string"
6445
6781
  },
6782
+ "user_data": {
6783
+ "title": "User Data",
6784
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
6785
+ "type": "object"
6786
+ },
6446
6787
  "type": {
6447
6788
  "title": "Type",
6448
6789
  "default": "ConstructionSet",
@@ -6553,6 +6894,11 @@
6553
6894
  "description": "Display name of the object with no character restrictions.",
6554
6895
  "type": "string"
6555
6896
  },
6897
+ "user_data": {
6898
+ "title": "User Data",
6899
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
6900
+ "type": "object"
6901
+ },
6556
6902
  "type": {
6557
6903
  "title": "Type",
6558
6904
  "default": "WindowConstructionShadeAbridged",
@@ -6632,6 +6978,11 @@
6632
6978
  "description": "Display name of the object with no character restrictions.",
6633
6979
  "type": "string"
6634
6980
  },
6981
+ "user_data": {
6982
+ "title": "User Data",
6983
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
6984
+ "type": "object"
6985
+ },
6635
6986
  "type": {
6636
6987
  "title": "Type",
6637
6988
  "default": "WindowConstructionDynamicAbridged",
@@ -6690,6 +7041,11 @@
6690
7041
  "description": "Display name of the object with no character restrictions.",
6691
7042
  "type": "string"
6692
7043
  },
7044
+ "user_data": {
7045
+ "title": "User Data",
7046
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
7047
+ "type": "object"
7048
+ },
6693
7049
  "type": {
6694
7050
  "title": "Type",
6695
7051
  "default": "IdealAirSystemAbridged",
@@ -6877,6 +7233,11 @@
6877
7233
  "description": "Display name of the object with no character restrictions.",
6878
7234
  "type": "string"
6879
7235
  },
7236
+ "user_data": {
7237
+ "title": "User Data",
7238
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
7239
+ "type": "object"
7240
+ },
6880
7241
  "vintage": {
6881
7242
  "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",
6882
7243
  "default": "ASHRAE_2019",
@@ -6971,6 +7332,11 @@
6971
7332
  "description": "Display name of the object with no character restrictions.",
6972
7333
  "type": "string"
6973
7334
  },
7335
+ "user_data": {
7336
+ "title": "User Data",
7337
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
7338
+ "type": "object"
7339
+ },
6974
7340
  "vintage": {
6975
7341
  "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",
6976
7342
  "default": "ASHRAE_2019",
@@ -7080,6 +7446,11 @@
7080
7446
  "description": "Display name of the object with no character restrictions.",
7081
7447
  "type": "string"
7082
7448
  },
7449
+ "user_data": {
7450
+ "title": "User Data",
7451
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
7452
+ "type": "object"
7453
+ },
7083
7454
  "vintage": {
7084
7455
  "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",
7085
7456
  "default": "ASHRAE_2019",
@@ -7180,6 +7551,11 @@
7180
7551
  "description": "Display name of the object with no character restrictions.",
7181
7552
  "type": "string"
7182
7553
  },
7554
+ "user_data": {
7555
+ "title": "User Data",
7556
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
7557
+ "type": "object"
7558
+ },
7183
7559
  "vintage": {
7184
7560
  "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",
7185
7561
  "default": "ASHRAE_2019",
@@ -7237,6 +7613,11 @@
7237
7613
  "description": "Display name of the object with no character restrictions.",
7238
7614
  "type": "string"
7239
7615
  },
7616
+ "user_data": {
7617
+ "title": "User Data",
7618
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
7619
+ "type": "object"
7620
+ },
7240
7621
  "vintage": {
7241
7622
  "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",
7242
7623
  "default": "ASHRAE_2019",
@@ -7344,6 +7725,11 @@
7344
7725
  "description": "Display name of the object with no character restrictions.",
7345
7726
  "type": "string"
7346
7727
  },
7728
+ "user_data": {
7729
+ "title": "User Data",
7730
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
7731
+ "type": "object"
7732
+ },
7347
7733
  "vintage": {
7348
7734
  "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",
7349
7735
  "default": "ASHRAE_2019",
@@ -7435,6 +7821,11 @@
7435
7821
  "description": "Display name of the object with no character restrictions.",
7436
7822
  "type": "string"
7437
7823
  },
7824
+ "user_data": {
7825
+ "title": "User Data",
7826
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
7827
+ "type": "object"
7828
+ },
7438
7829
  "vintage": {
7439
7830
  "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",
7440
7831
  "default": "ASHRAE_2019",
@@ -7523,6 +7914,11 @@
7523
7914
  "description": "Display name of the object with no character restrictions.",
7524
7915
  "type": "string"
7525
7916
  },
7917
+ "user_data": {
7918
+ "title": "User Data",
7919
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
7920
+ "type": "object"
7921
+ },
7526
7922
  "vintage": {
7527
7923
  "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",
7528
7924
  "default": "ASHRAE_2019",
@@ -7628,6 +8024,11 @@
7628
8024
  "description": "Display name of the object with no character restrictions.",
7629
8025
  "type": "string"
7630
8026
  },
8027
+ "user_data": {
8028
+ "title": "User Data",
8029
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8030
+ "type": "object"
8031
+ },
7631
8032
  "vintage": {
7632
8033
  "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",
7633
8034
  "default": "ASHRAE_2019",
@@ -7688,6 +8089,11 @@
7688
8089
  "description": "Display name of the object with no character restrictions.",
7689
8090
  "type": "string"
7690
8091
  },
8092
+ "user_data": {
8093
+ "title": "User Data",
8094
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8095
+ "type": "object"
8096
+ },
7691
8097
  "vintage": {
7692
8098
  "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",
7693
8099
  "default": "ASHRAE_2019",
@@ -7745,6 +8151,11 @@
7745
8151
  "description": "Display name of the object with no character restrictions.",
7746
8152
  "type": "string"
7747
8153
  },
8154
+ "user_data": {
8155
+ "title": "User Data",
8156
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8157
+ "type": "object"
8158
+ },
7748
8159
  "vintage": {
7749
8160
  "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",
7750
8161
  "default": "ASHRAE_2019",
@@ -7805,6 +8216,11 @@
7805
8216
  "description": "Display name of the object with no character restrictions.",
7806
8217
  "type": "string"
7807
8218
  },
8219
+ "user_data": {
8220
+ "title": "User Data",
8221
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8222
+ "type": "object"
8223
+ },
7808
8224
  "vintage": {
7809
8225
  "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",
7810
8226
  "default": "ASHRAE_2019",
@@ -7868,6 +8284,11 @@
7868
8284
  "description": "Display name of the object with no character restrictions.",
7869
8285
  "type": "string"
7870
8286
  },
8287
+ "user_data": {
8288
+ "title": "User Data",
8289
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8290
+ "type": "object"
8291
+ },
7871
8292
  "vintage": {
7872
8293
  "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",
7873
8294
  "default": "ASHRAE_2019",
@@ -7933,6 +8354,11 @@
7933
8354
  "description": "Display name of the object with no character restrictions.",
7934
8355
  "type": "string"
7935
8356
  },
8357
+ "user_data": {
8358
+ "title": "User Data",
8359
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8360
+ "type": "object"
8361
+ },
7936
8362
  "vintage": {
7937
8363
  "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",
7938
8364
  "default": "ASHRAE_2019",
@@ -7996,6 +8422,11 @@
7996
8422
  "description": "Display name of the object with no character restrictions.",
7997
8423
  "type": "string"
7998
8424
  },
8425
+ "user_data": {
8426
+ "title": "User Data",
8427
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8428
+ "type": "object"
8429
+ },
7999
8430
  "vintage": {
8000
8431
  "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",
8001
8432
  "default": "ASHRAE_2019",
@@ -8053,6 +8484,11 @@
8053
8484
  "description": "Display name of the object with no character restrictions.",
8054
8485
  "type": "string"
8055
8486
  },
8487
+ "user_data": {
8488
+ "title": "User Data",
8489
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8490
+ "type": "object"
8491
+ },
8056
8492
  "vintage": {
8057
8493
  "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",
8058
8494
  "default": "ASHRAE_2019",
@@ -8084,9 +8520,104 @@
8084
8520
  ],
8085
8521
  "additionalProperties": false
8086
8522
  },
8523
+ "SHWEquipmentType": {
8524
+ "title": "SHWEquipmentType",
8525
+ "description": "An enumeration.",
8526
+ "enum": [
8527
+ "Gas_WaterHeater",
8528
+ "Electric_WaterHeater",
8529
+ "HeatPump_WaterHeater",
8530
+ "Gas_TanklessHeater",
8531
+ "Electric_TanklessHeater"
8532
+ ],
8533
+ "type": "string"
8534
+ },
8535
+ "SHWSystem": {
8536
+ "title": "SHWSystem",
8537
+ "description": "Provides a model for a Service Hot Water system.",
8538
+ "type": "object",
8539
+ "properties": {
8540
+ "identifier": {
8541
+ "title": "Identifier",
8542
+ "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).",
8543
+ "maxLength": 100,
8544
+ "minLength": 1,
8545
+ "pattern": "^[^,;!\\n\\t]+$",
8546
+ "type": "string"
8547
+ },
8548
+ "display_name": {
8549
+ "title": "Display Name",
8550
+ "description": "Display name of the object with no character restrictions.",
8551
+ "type": "string"
8552
+ },
8553
+ "user_data": {
8554
+ "title": "User Data",
8555
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8556
+ "type": "object"
8557
+ },
8558
+ "type": {
8559
+ "title": "Type",
8560
+ "default": "SHWSystem",
8561
+ "pattern": "^SHWSystem$",
8562
+ "type": "string",
8563
+ "readOnly": true
8564
+ },
8565
+ "equipment_type": {
8566
+ "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.",
8567
+ "default": "Gas_WaterHeater",
8568
+ "allOf": [
8569
+ {
8570
+ "$ref": "#/components/schemas/SHWEquipmentType"
8571
+ }
8572
+ ]
8573
+ },
8574
+ "heater_efficiency": {
8575
+ "title": "Heater Efficiency",
8576
+ "description": "A number for the efficiency of the heater within the system. For Gas systems, this is the efficiency of the burner. For HeatPump systems, this is the rated COP of the system. For electric systems, this should usually be set to 1. If set to Autocalculate, this value will automatically be set based on the equipment_type. Gas_WaterHeater - 0.8, Electric_WaterHeater - 1.0, HeatPump_WaterHeater - 3.5, Gas_TanklessHeater - 0.8, Electric_TanklessHeater - 1.0.",
8577
+ "default": {
8578
+ "type": "Autocalculate"
8579
+ },
8580
+ "anyOf": [
8581
+ {
8582
+ "type": "number",
8583
+ "exclusiveMinimum": 0,
8584
+ "format": "double"
8585
+ },
8586
+ {
8587
+ "$ref": "#/components/schemas/Autocalculate"
8588
+ }
8589
+ ]
8590
+ },
8591
+ "ambient_condition": {
8592
+ "title": "Ambient Condition",
8593
+ "description": "A number for the ambient temperature in which the hot water tank is located [C]. This can also be the identifier of a Room in which the tank is located.",
8594
+ "default": 22,
8595
+ "anyOf": [
8596
+ {
8597
+ "type": "number",
8598
+ "format": "double"
8599
+ },
8600
+ {
8601
+ "type": "string"
8602
+ }
8603
+ ]
8604
+ },
8605
+ "ambient_loss_coefficient": {
8606
+ "title": "Ambient Loss Coefficient",
8607
+ "description": "A number for the loss of heat from the water heater tank to the surrounding ambient conditions [W/K].",
8608
+ "default": 6,
8609
+ "type": "number",
8610
+ "format": "double"
8611
+ }
8612
+ },
8613
+ "required": [
8614
+ "identifier"
8615
+ ],
8616
+ "additionalProperties": false
8617
+ },
8087
8618
  "ProgramTypeAbridged": {
8088
8619
  "title": "ProgramTypeAbridged",
8089
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
8620
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
8090
8621
  "type": "object",
8091
8622
  "properties": {
8092
8623
  "identifier": {
@@ -8102,6 +8633,11 @@
8102
8633
  "description": "Display name of the object with no character restrictions.",
8103
8634
  "type": "string"
8104
8635
  },
8636
+ "user_data": {
8637
+ "title": "User Data",
8638
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8639
+ "type": "object"
8640
+ },
8105
8641
  "type": {
8106
8642
  "title": "Type",
8107
8643
  "default": "ProgramTypeAbridged",
@@ -8189,7 +8725,7 @@
8189
8725
  },
8190
8726
  "People": {
8191
8727
  "title": "People",
8192
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
8728
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
8193
8729
  "type": "object",
8194
8730
  "properties": {
8195
8731
  "identifier": {
@@ -8224,6 +8760,11 @@
8224
8760
  "description": "Display name of the object with no character restrictions.",
8225
8761
  "type": "string"
8226
8762
  },
8763
+ "user_data": {
8764
+ "title": "User Data",
8765
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8766
+ "type": "object"
8767
+ },
8227
8768
  "type": {
8228
8769
  "title": "Type",
8229
8770
  "default": "People",
@@ -8280,7 +8821,7 @@
8280
8821
  },
8281
8822
  "Lighting": {
8282
8823
  "title": "Lighting",
8283
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
8824
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
8284
8825
  "type": "object",
8285
8826
  "properties": {
8286
8827
  "identifier": {
@@ -8315,6 +8856,11 @@
8315
8856
  "description": "Display name of the object with no character restrictions.",
8316
8857
  "type": "string"
8317
8858
  },
8859
+ "user_data": {
8860
+ "title": "User Data",
8861
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8862
+ "type": "object"
8863
+ },
8318
8864
  "type": {
8319
8865
  "title": "Type",
8320
8866
  "default": "Lighting",
@@ -8367,7 +8913,7 @@
8367
8913
  },
8368
8914
  "ElectricEquipment": {
8369
8915
  "title": "ElectricEquipment",
8370
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
8916
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
8371
8917
  "type": "object",
8372
8918
  "properties": {
8373
8919
  "identifier": {
@@ -8402,9 +8948,14 @@
8402
8948
  "description": "Display name of the object with no character restrictions.",
8403
8949
  "type": "string"
8404
8950
  },
8951
+ "user_data": {
8952
+ "title": "User Data",
8953
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
8954
+ "type": "object"
8955
+ },
8405
8956
  "radiant_fraction": {
8406
8957
  "title": "Radiant Fraction",
8407
- "description": "Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.",
8958
+ "description": "Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.",
8408
8959
  "default": 0,
8409
8960
  "minimum": 0,
8410
8961
  "maximum": 1,
@@ -8413,7 +8964,7 @@
8413
8964
  },
8414
8965
  "latent_fraction": {
8415
8966
  "title": "Latent Fraction",
8416
- "description": "Number for the amount of latent heat given off by electricequipment. Default value is 0.",
8967
+ "description": "Number for the amount of latent heat given off by equipment. Default value is 0.",
8417
8968
  "default": 0,
8418
8969
  "minimum": 0,
8419
8970
  "maximum": 1,
@@ -8446,7 +8997,7 @@
8446
8997
  },
8447
8998
  "GasEquipment": {
8448
8999
  "title": "GasEquipment",
8449
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
9000
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
8450
9001
  "type": "object",
8451
9002
  "properties": {
8452
9003
  "identifier": {
@@ -8481,9 +9032,14 @@
8481
9032
  "description": "Display name of the object with no character restrictions.",
8482
9033
  "type": "string"
8483
9034
  },
9035
+ "user_data": {
9036
+ "title": "User Data",
9037
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
9038
+ "type": "object"
9039
+ },
8484
9040
  "radiant_fraction": {
8485
9041
  "title": "Radiant Fraction",
8486
- "description": "Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.",
9042
+ "description": "Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.",
8487
9043
  "default": 0,
8488
9044
  "minimum": 0,
8489
9045
  "maximum": 1,
@@ -8492,7 +9048,7 @@
8492
9048
  },
8493
9049
  "latent_fraction": {
8494
9050
  "title": "Latent Fraction",
8495
- "description": "Number for the amount of latent heat given off by electricequipment. Default value is 0.",
9051
+ "description": "Number for the amount of latent heat given off by equipment. Default value is 0.",
8496
9052
  "default": 0,
8497
9053
  "minimum": 0,
8498
9054
  "maximum": 1,
@@ -8525,7 +9081,7 @@
8525
9081
  },
8526
9082
  "ServiceHotWater": {
8527
9083
  "title": "ServiceHotWater",
8528
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
9084
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
8529
9085
  "type": "object",
8530
9086
  "properties": {
8531
9087
  "identifier": {
@@ -8560,6 +9116,11 @@
8560
9116
  "description": "Display name of the object with no character restrictions.",
8561
9117
  "type": "string"
8562
9118
  },
9119
+ "user_data": {
9120
+ "title": "User Data",
9121
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
9122
+ "type": "object"
9123
+ },
8563
9124
  "type": {
8564
9125
  "title": "Type",
8565
9126
  "default": "ServiceHotWater",
@@ -8603,7 +9164,7 @@
8603
9164
  },
8604
9165
  "Infiltration": {
8605
9166
  "title": "Infiltration",
8606
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
9167
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
8607
9168
  "type": "object",
8608
9169
  "properties": {
8609
9170
  "identifier": {
@@ -8638,6 +9199,11 @@
8638
9199
  "description": "Display name of the object with no character restrictions.",
8639
9200
  "type": "string"
8640
9201
  },
9202
+ "user_data": {
9203
+ "title": "User Data",
9204
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
9205
+ "type": "object"
9206
+ },
8641
9207
  "type": {
8642
9208
  "title": "Type",
8643
9209
  "default": "Infiltration",
@@ -8676,7 +9242,7 @@
8676
9242
  },
8677
9243
  "Ventilation": {
8678
9244
  "title": "Ventilation",
8679
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
9245
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
8680
9246
  "type": "object",
8681
9247
  "properties": {
8682
9248
  "identifier": {
@@ -8692,6 +9258,11 @@
8692
9258
  "description": "Display name of the object with no character restrictions.",
8693
9259
  "type": "string"
8694
9260
  },
9261
+ "user_data": {
9262
+ "title": "User Data",
9263
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
9264
+ "type": "object"
9265
+ },
8695
9266
  "type": {
8696
9267
  "title": "Type",
8697
9268
  "default": "Ventilation",
@@ -8791,6 +9362,11 @@
8791
9362
  "description": "Display name of the object with no character restrictions.",
8792
9363
  "type": "string"
8793
9364
  },
9365
+ "user_data": {
9366
+ "title": "User Data",
9367
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
9368
+ "type": "object"
9369
+ },
8794
9370
  "type": {
8795
9371
  "title": "Type",
8796
9372
  "default": "Setpoint",
@@ -8832,7 +9408,7 @@
8832
9408
  },
8833
9409
  "ProgramType": {
8834
9410
  "title": "ProgramType",
8835
- "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
9411
+ "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
8836
9412
  "type": "object",
8837
9413
  "properties": {
8838
9414
  "identifier": {
@@ -8848,6 +9424,11 @@
8848
9424
  "description": "Display name of the object with no character restrictions.",
8849
9425
  "type": "string"
8850
9426
  },
9427
+ "user_data": {
9428
+ "title": "User Data",
9429
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
9430
+ "type": "object"
9431
+ },
8851
9432
  "type": {
8852
9433
  "title": "Type",
8853
9434
  "default": "ProgramType",
@@ -8966,6 +9547,11 @@
8966
9547
  "description": "Display name of the object with no character restrictions.",
8967
9548
  "type": "string"
8968
9549
  },
9550
+ "user_data": {
9551
+ "title": "User Data",
9552
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
9553
+ "type": "object"
9554
+ },
8969
9555
  "type": {
8970
9556
  "title": "Type",
8971
9557
  "default": "ScheduleRulesetAbridged",
@@ -9046,6 +9632,11 @@
9046
9632
  "description": "Display name of the object with no character restrictions.",
9047
9633
  "type": "string"
9048
9634
  },
9635
+ "user_data": {
9636
+ "title": "User Data",
9637
+ "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
9638
+ "type": "object"
9639
+ },
9049
9640
  "type": {
9050
9641
  "title": "Type",
9051
9642
  "default": "ScheduleFixedIntervalAbridged",
@@ -9218,6 +9809,7 @@
9218
9809
  {
9219
9810
  "identifier": "Generic Roof Membrane",
9220
9811
  "display_name": null,
9812
+ "user_data": null,
9221
9813
  "type": "EnergyMaterial",
9222
9814
  "roughness": "MediumRough",
9223
9815
  "thickness": 0.01,
@@ -9231,6 +9823,7 @@
9231
9823
  {
9232
9824
  "identifier": "Generic Acoustic Tile",
9233
9825
  "display_name": null,
9826
+ "user_data": null,
9234
9827
  "type": "EnergyMaterial",
9235
9828
  "roughness": "MediumSmooth",
9236
9829
  "thickness": 0.02,
@@ -9244,6 +9837,7 @@
9244
9837
  {
9245
9838
  "identifier": "Generic 25mm Wood",
9246
9839
  "display_name": null,
9840
+ "user_data": null,
9247
9841
  "type": "EnergyMaterial",
9248
9842
  "roughness": "MediumSmooth",
9249
9843
  "thickness": 0.0254,
@@ -9257,6 +9851,7 @@
9257
9851
  {
9258
9852
  "identifier": "Generic HW Concrete",
9259
9853
  "display_name": null,
9854
+ "user_data": null,
9260
9855
  "type": "EnergyMaterial",
9261
9856
  "roughness": "MediumRough",
9262
9857
  "thickness": 0.2,
@@ -9270,6 +9865,7 @@
9270
9865
  {
9271
9866
  "identifier": "Generic Window Air Gap",
9272
9867
  "display_name": null,
9868
+ "user_data": null,
9273
9869
  "type": "EnergyWindowMaterialGas",
9274
9870
  "thickness": 0.0127,
9275
9871
  "gas_type": "Air"
@@ -9277,6 +9873,7 @@
9277
9873
  {
9278
9874
  "identifier": "Generic Gypsum Board",
9279
9875
  "display_name": null,
9876
+ "user_data": null,
9280
9877
  "type": "EnergyMaterial",
9281
9878
  "roughness": "MediumSmooth",
9282
9879
  "thickness": 0.0127,
@@ -9290,6 +9887,7 @@
9290
9887
  {
9291
9888
  "identifier": "Generic Wall Air Gap",
9292
9889
  "display_name": null,
9890
+ "user_data": null,
9293
9891
  "type": "EnergyMaterial",
9294
9892
  "roughness": "Smooth",
9295
9893
  "thickness": 0.1,
@@ -9303,6 +9901,7 @@
9303
9901
  {
9304
9902
  "identifier": "Generic Ceiling Air Gap",
9305
9903
  "display_name": null,
9904
+ "user_data": null,
9306
9905
  "type": "EnergyMaterial",
9307
9906
  "roughness": "Smooth",
9308
9907
  "thickness": 0.1,
@@ -9316,6 +9915,7 @@
9316
9915
  {
9317
9916
  "identifier": "Generic Brick",
9318
9917
  "display_name": null,
9918
+ "user_data": null,
9319
9919
  "type": "EnergyMaterial",
9320
9920
  "roughness": "MediumRough",
9321
9921
  "thickness": 0.1,
@@ -9329,6 +9929,7 @@
9329
9929
  {
9330
9930
  "identifier": "Generic 50mm Insulation",
9331
9931
  "display_name": null,
9932
+ "user_data": null,
9332
9933
  "type": "EnergyMaterial",
9333
9934
  "roughness": "MediumRough",
9334
9935
  "thickness": 0.05,
@@ -9342,6 +9943,7 @@
9342
9943
  {
9343
9944
  "identifier": "Generic Low-e Glass",
9344
9945
  "display_name": null,
9946
+ "user_data": null,
9345
9947
  "type": "EnergyWindowMaterialGlazing",
9346
9948
  "thickness": 0.006,
9347
9949
  "solar_transmittance": 0.45,
@@ -9360,6 +9962,7 @@
9360
9962
  {
9361
9963
  "identifier": "Generic Painted Metal",
9362
9964
  "display_name": null,
9965
+ "user_data": null,
9363
9966
  "type": "EnergyMaterial",
9364
9967
  "roughness": "Smooth",
9365
9968
  "thickness": 0.0015,
@@ -9373,6 +9976,7 @@
9373
9976
  {
9374
9977
  "identifier": "Generic LW Concrete",
9375
9978
  "display_name": null,
9979
+ "user_data": null,
9376
9980
  "type": "EnergyMaterial",
9377
9981
  "roughness": "MediumRough",
9378
9982
  "thickness": 0.1,
@@ -9386,6 +9990,7 @@
9386
9990
  {
9387
9991
  "identifier": "Generic 25mm Insulation",
9388
9992
  "display_name": null,
9993
+ "user_data": null,
9389
9994
  "type": "EnergyMaterial",
9390
9995
  "roughness": "MediumRough",
9391
9996
  "thickness": 0.05,
@@ -9399,6 +10004,7 @@
9399
10004
  {
9400
10005
  "identifier": "Generic Clear Glass",
9401
10006
  "display_name": null,
10007
+ "user_data": null,
9402
10008
  "type": "EnergyWindowMaterialGlazing",
9403
10009
  "thickness": 0.006,
9404
10010
  "solar_transmittance": 0.77,
@@ -9419,6 +10025,7 @@
9419
10025
  {
9420
10026
  "identifier": "Generic Interior Door",
9421
10027
  "display_name": null,
10028
+ "user_data": null,
9422
10029
  "type": "OpaqueConstructionAbridged",
9423
10030
  "materials": [
9424
10031
  "Generic 25mm Wood"
@@ -9427,6 +10034,7 @@
9427
10034
  {
9428
10035
  "identifier": "Generic Single Pane",
9429
10036
  "display_name": null,
10037
+ "user_data": null,
9430
10038
  "type": "WindowConstructionAbridged",
9431
10039
  "materials": [
9432
10040
  "Generic Clear Glass"
@@ -9435,6 +10043,7 @@
9435
10043
  {
9436
10044
  "identifier": "Generic Shade",
9437
10045
  "display_name": null,
10046
+ "user_data": null,
9438
10047
  "type": "ShadeConstruction",
9439
10048
  "solar_reflectance": 0.35,
9440
10049
  "visible_reflectance": 0.35,
@@ -9443,6 +10052,7 @@
9443
10052
  {
9444
10053
  "identifier": "Generic Interior Ceiling",
9445
10054
  "display_name": null,
10055
+ "user_data": null,
9446
10056
  "type": "OpaqueConstructionAbridged",
9447
10057
  "materials": [
9448
10058
  "Generic LW Concrete",
@@ -9453,6 +10063,7 @@
9453
10063
  {
9454
10064
  "identifier": "Generic Interior Wall",
9455
10065
  "display_name": null,
10066
+ "user_data": null,
9456
10067
  "type": "OpaqueConstructionAbridged",
9457
10068
  "materials": [
9458
10069
  "Generic Gypsum Board",
@@ -9463,6 +10074,7 @@
9463
10074
  {
9464
10075
  "identifier": "Generic Exposed Floor",
9465
10076
  "display_name": null,
10077
+ "user_data": null,
9466
10078
  "type": "OpaqueConstructionAbridged",
9467
10079
  "materials": [
9468
10080
  "Generic Painted Metal",
@@ -9474,6 +10086,7 @@
9474
10086
  {
9475
10087
  "identifier": "Generic Interior Floor",
9476
10088
  "display_name": null,
10089
+ "user_data": null,
9477
10090
  "type": "OpaqueConstructionAbridged",
9478
10091
  "materials": [
9479
10092
  "Generic Acoustic Tile",
@@ -9484,6 +10097,7 @@
9484
10097
  {
9485
10098
  "identifier": "Generic Ground Slab",
9486
10099
  "display_name": null,
10100
+ "user_data": null,
9487
10101
  "type": "OpaqueConstructionAbridged",
9488
10102
  "materials": [
9489
10103
  "Generic 50mm Insulation",
@@ -9493,6 +10107,7 @@
9493
10107
  {
9494
10108
  "identifier": "Generic Roof",
9495
10109
  "display_name": null,
10110
+ "user_data": null,
9496
10111
  "type": "OpaqueConstructionAbridged",
9497
10112
  "materials": [
9498
10113
  "Generic Roof Membrane",
@@ -9505,6 +10120,7 @@
9505
10120
  {
9506
10121
  "identifier": "Generic Exterior Wall",
9507
10122
  "display_name": null,
10123
+ "user_data": null,
9508
10124
  "type": "OpaqueConstructionAbridged",
9509
10125
  "materials": [
9510
10126
  "Generic Brick",
@@ -9517,6 +10133,7 @@
9517
10133
  {
9518
10134
  "identifier": "Generic Underground Wall",
9519
10135
  "display_name": null,
10136
+ "user_data": null,
9520
10137
  "type": "OpaqueConstructionAbridged",
9521
10138
  "materials": [
9522
10139
  "Generic 50mm Insulation",
@@ -9528,6 +10145,7 @@
9528
10145
  {
9529
10146
  "identifier": "Generic Air Boundary",
9530
10147
  "display_name": null,
10148
+ "user_data": null,
9531
10149
  "type": "AirBoundaryConstructionAbridged",
9532
10150
  "air_mixing_per_area": 0.1,
9533
10151
  "air_mixing_schedule": "Always On"
@@ -9535,6 +10153,7 @@
9535
10153
  {
9536
10154
  "identifier": "Generic Underground Roof",
9537
10155
  "display_name": null,
10156
+ "user_data": null,
9538
10157
  "type": "OpaqueConstructionAbridged",
9539
10158
  "materials": [
9540
10159
  "Generic 50mm Insulation",
@@ -9546,6 +10165,7 @@
9546
10165
  {
9547
10166
  "identifier": "Generic Double Pane",
9548
10167
  "display_name": null,
10168
+ "user_data": null,
9549
10169
  "type": "WindowConstructionAbridged",
9550
10170
  "materials": [
9551
10171
  "Generic Low-e Glass",
@@ -9556,6 +10176,7 @@
9556
10176
  {
9557
10177
  "identifier": "Generic Exterior Door",
9558
10178
  "display_name": null,
10179
+ "user_data": null,
9559
10180
  "type": "OpaqueConstructionAbridged",
9560
10181
  "materials": [
9561
10182
  "Generic Painted Metal",
@@ -9760,6 +10381,14 @@
9760
10381
  ]
9761
10382
  }
9762
10383
  },
10384
+ "shws": {
10385
+ "title": "Shws",
10386
+ "description": "List of all unique Service Hot Water (SHW) systems in the Model.",
10387
+ "type": "array",
10388
+ "items": {
10389
+ "$ref": "#/components/schemas/SHWSystem"
10390
+ }
10391
+ },
9763
10392
  "program_types": {
9764
10393
  "title": "Program Types",
9765
10394
  "description": "List of all unique ProgramTypes in the Model.",
@@ -10873,9 +11502,9 @@
10873
11502
  },
10874
11503
  "refraction_index": {
10875
11504
  "title": "Refraction Index",
10876
- "description": "A value between 0 and 1 for the index of refraction.",
11505
+ "description": "A value greater than 1 for the index of refraction. Typical values are 1.52 for float glass and 1.4 for ETFE.",
10877
11506
  "default": 1.52,
10878
- "minimum": 0,
11507
+ "exclusiveMinimum": 1,
10879
11508
  "type": "number",
10880
11509
  "format": "double"
10881
11510
  }
@@ -11341,6 +11970,9 @@
11341
11970
  },
11342
11971
  {
11343
11972
  "$ref": "#/components/schemas/Glass"
11973
+ },
11974
+ {
11975
+ "$ref": "#/components/schemas/Trans"
11344
11976
  }
11345
11977
  ]
11346
11978
  }
@@ -12980,7 +13612,7 @@
12980
13612
  "version": {
12981
13613
  "title": "Version",
12982
13614
  "description": "Text string for the current version of the schema.",
12983
- "default": "1.44.2",
13615
+ "default": "1.46.1",
12984
13616
  "pattern": "([0-9]+)\\.([0-9]+)\\.([0-9]+)",
12985
13617
  "type": "string",
12986
13618
  "readOnly": true