honeybee-openstudio 2.5.2 → 2.6.3

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: e4049f4bfe550b01a9c9337fccd8344c8bd209ecb6bff6c29970fc301161d8aa
4
- data.tar.gz: 54d8061d079ea1b0b43364a667918ea89e1694967d58da2d469725ef86a94492
3
+ metadata.gz: 46f958f941dcbcdad96fce63f736bb5ab0e49b13864a3ef086e97b28a4b92bfa
4
+ data.tar.gz: 2e140ea4e6549a7789b7dec00679440e5fb57eb45171a35632f74ad90376e9f4
5
5
  SHA512:
6
- metadata.gz: 7a3051d0e5850922f99df67c8304600c3fd5df3faa2a4aa37bd8ed60c8a436a986b252b327b11682ab7098d1b19e9472e84e6fa6bdf9df334a067e74581885b5
7
- data.tar.gz: 3e00b711ace9a3950c550b0eaac1fb89f629409188c9f4b3d2591439e0d814db03ed735c806badd793fd6dd9a09b5687160614f928610509ccb6591ac8cd8fe9
6
+ metadata.gz: 0f25e4e7fca7015a52f6c17eb68f685655d07f53e9887f6952fe3978e42e48b932c15ef20b1993bda426070906f6e8cd30d41aa582322b99558c62ebd31598ea
7
+ data.tar.gz: 163fa7ddfbc15fedabe33bcc3be61642596068b0c901cb519d034e2749ec24effda71829abcd97ec16d14e495967772ad8d23068d1da66f58c7582d81ae2f35c
@@ -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.5.2'
7
+ spec.version = '2.6.3'
8
8
  spec.authors = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
9
9
  spec.email = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
10
10
 
@@ -21,4 +21,4 @@ else
21
21
  end
22
22
 
23
23
  # include the honeybee-openstudio-gem
24
- gem 'honeybee-openstudio', '2.3.0'
24
+ gem 'honeybee-openstudio', '2.5.3'
@@ -24,6 +24,11 @@
24
24
  "url": "./model_inheritance.json"
25
25
  },
26
26
  "tags": [
27
+ {
28
+ "name": "afncrack_model",
29
+ "x-displayName": "AFNCrack",
30
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AFNCrack\" />\n"
31
+ },
27
32
  {
28
33
  "name": "adiabatic_model",
29
34
  "x-displayName": "Adiabatic",
@@ -109,6 +114,16 @@
109
114
  "x-displayName": "BaseboardEquipmentType",
110
115
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BaseboardEquipmentType\" />\n"
111
116
  },
117
+ {
118
+ "name": "buildingtype_model",
119
+ "x-displayName": "BuildingType",
120
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BuildingType\" />\n"
121
+ },
122
+ {
123
+ "name": "color_model",
124
+ "x-displayName": "Color",
125
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Color\" />\n"
126
+ },
112
127
  {
113
128
  "name": "constructionset_model",
114
129
  "x-displayName": "ConstructionSet",
@@ -384,6 +399,11 @@
384
399
  "x-displayName": "LightingAbridged",
385
400
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LightingAbridged\" />\n"
386
401
  },
402
+ {
403
+ "name": "mesh3d_model",
404
+ "x-displayName": "Mesh3D",
405
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Mesh3D\" />\n"
406
+ },
387
407
  {
388
408
  "name": "metal_model",
389
409
  "x-displayName": "Metal",
@@ -614,6 +634,16 @@
614
634
  "x-displayName": "ScheduleUnitType",
615
635
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScheduleUnitType\" />\n"
616
636
  },
637
+ {
638
+ "name": "sensor_model",
639
+ "x-displayName": "Sensor",
640
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Sensor\" />\n"
641
+ },
642
+ {
643
+ "name": "sensorgrid_model",
644
+ "x-displayName": "SensorGrid",
645
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SensorGrid\" />\n"
646
+ },
617
647
  {
618
648
  "name": "setpoint_model",
619
649
  "x-displayName": "Setpoint",
@@ -734,11 +764,31 @@
734
764
  "x-displayName": "VentilationControlAbridged",
735
765
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationControlAbridged\" />\n"
736
766
  },
767
+ {
768
+ "name": "ventilationcontroltype_model",
769
+ "x-displayName": "VentilationControlType",
770
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationControlType\" />\n"
771
+ },
737
772
  {
738
773
  "name": "ventilationopening_model",
739
774
  "x-displayName": "VentilationOpening",
740
775
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationOpening\" />\n"
741
776
  },
777
+ {
778
+ "name": "ventilationsimulationcontrol_model",
779
+ "x-displayName": "VentilationSimulationControl",
780
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationSimulationControl\" />\n"
781
+ },
782
+ {
783
+ "name": "view_model",
784
+ "x-displayName": "View",
785
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/View\" />\n"
786
+ },
787
+ {
788
+ "name": "viewtype_model",
789
+ "x-displayName": "ViewType",
790
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ViewType\" />\n"
791
+ },
742
792
  {
743
793
  "name": "vintages_model",
744
794
  "x-displayName": "Vintages",
@@ -825,6 +875,7 @@
825
875
  "name": "Models",
826
876
  "tags": [
827
877
  "adiabatic_model",
878
+ "afncrack_model",
828
879
  "airboundaryconstruction_model",
829
880
  "airboundaryconstructionabridged_model",
830
881
  "allaireconomizertype_model",
@@ -841,6 +892,8 @@
841
892
  "baseboard_model",
842
893
  "baseboardequipmenttype_model",
843
894
  "bsdf_model",
895
+ "buildingtype_model",
896
+ "color_model",
844
897
  "constructionset_model",
845
898
  "constructionsetabridged_model",
846
899
  "controltype_model",
@@ -896,6 +949,7 @@
896
949
  "light_model",
897
950
  "lighting_model",
898
951
  "lightingabridged_model",
952
+ "mesh3d_model",
899
953
  "metal_model",
900
954
  "mirror_model",
901
955
  "model_model",
@@ -942,6 +996,8 @@
942
996
  "schedulerulesetabridged_model",
943
997
  "scheduletypelimit_model",
944
998
  "scheduleunittype_model",
999
+ "sensor_model",
1000
+ "sensorgrid_model",
945
1001
  "setpoint_model",
946
1002
  "setpointabridged_model",
947
1003
  "shade_model",
@@ -962,7 +1018,11 @@
962
1018
  "ventilation_model",
963
1019
  "ventilationabridged_model",
964
1020
  "ventilationcontrolabridged_model",
1021
+ "ventilationcontroltype_model",
965
1022
  "ventilationopening_model",
1023
+ "ventilationsimulationcontrol_model",
1024
+ "view_model",
1025
+ "viewtype_model",
966
1026
  "vintages_model",
967
1027
  "void_model",
968
1028
  "vrf_model",
@@ -1476,7 +1536,7 @@
1476
1536
  },
1477
1537
  "fraction_height_operable": {
1478
1538
  "title": "Fraction Height Operable",
1479
- "description": "A number for the fraction of the distance from the bottom of the window to the top that is operable.",
1539
+ "description": "A number for the fraction of the distance from the bottom of the window to the top that is operable",
1480
1540
  "default": 1.0,
1481
1541
  "minimum": 0,
1482
1542
  "maximum": 1,
@@ -1485,8 +1545,8 @@
1485
1545
  },
1486
1546
  "discharge_coefficient": {
1487
1547
  "title": "Discharge Coefficient",
1488
- "description": "A number that will be multipled by the area of the window in the stack (buoyancy-driven) part of the equation to account for additional friction from window geometry, insect screens, etc. Typical values include 0.17, for unobstructed windows with insect screens and 0.25 for unobstructed windows without insect screens. This value should be lowered if windows are of an awning or casement type and not allowed to fully open.",
1489
- "default": 0.17,
1548
+ "description": "A number that will be multipled by the area of the window in the stack (buoyancy-driven) part of the equation to account for additional friction from window geometry, insect screens, etc. Typical values include 0.45, for unobstructed windows WITH insect screens and 0.65 for unobstructed windows WITHOUT insect screens. This value should be lowered if windows are of an awning or casement type and are not allowed to fully open.",
1549
+ "default": 0.45,
1490
1550
  "minimum": 0,
1491
1551
  "maximum": 1,
1492
1552
  "type": "number",
@@ -1497,6 +1557,30 @@
1497
1557
  "description": "Boolean to indicate if there is an opening of roughly equal area on the opposite side of the Room such that wind-driven cross ventilation will be induced. If False, the assumption is that the operable area is primarily on one side of the Room and there is no wind-driven ventilation.",
1498
1558
  "default": false,
1499
1559
  "type": "boolean"
1560
+ },
1561
+ "flow_coefficient_closed": {
1562
+ "title": "Flow Coefficient Closed",
1563
+ "description": "An optional number in kg/s-m, at 1 Pa per meter of crack length, used to calculate the mass flow rate when the opening is closed; required to run an AirflowNetwork simulation. The DesignBuilder Cracks template defines the flow coefficient for a tight, low-leakage closed external window to be 0.00001, and the flow coefficient for a very poor, high-leakage closed external window to be 0.003.",
1564
+ "minimum": 0,
1565
+ "type": "number",
1566
+ "format": "double"
1567
+ },
1568
+ "flow_exponent_closed": {
1569
+ "title": "Flow Exponent Closed",
1570
+ "description": "An optional dimensionless number between 0.5 and 1 used to calculate the mass flow rate when the opening is closed; required to run an AirflowNetwork simulation. This value represents the leak geometry impact on airflow, with 0.5 generally corresponding to turbulent orifice flow and 1 generally corresponding to laminar flow. The default of 0.65 is representative of many cases of wall and window leakage, used when the exponent cannot be measured.",
1571
+ "default": 0.65,
1572
+ "minimum": 0.5,
1573
+ "maximum": 1,
1574
+ "type": "number",
1575
+ "format": "double"
1576
+ },
1577
+ "two_way_threshold": {
1578
+ "title": "Two Way Threshold",
1579
+ "description": "A number in kg/m3 indicating the minimum density difference above which two-way flow may occur due to stack effect, required to run an AirflowNetwork simulation. This value is required because the air density difference between two zones (which drives two-way air flow) will tend towards division by zero errors as the air density difference approaches zero. The default of 0.0001 is a typical default value used for AirflowNetwork openings.",
1580
+ "default": 0.0001,
1581
+ "exclusiveMinimum": 0,
1582
+ "type": "number",
1583
+ "format": "double"
1500
1584
  }
1501
1585
  },
1502
1586
  "additionalProperties": false
@@ -1908,6 +1992,40 @@
1908
1992
  ],
1909
1993
  "additionalProperties": false
1910
1994
  },
1995
+ "AFNCrack": {
1996
+ "title": "AFNCrack",
1997
+ "description": "Properties for airflow through a crack.",
1998
+ "type": "object",
1999
+ "properties": {
2000
+ "flow_coefficient": {
2001
+ "title": "Flow Coefficient",
2002
+ "description": "A number in kg/s-m at 1 Pa per meter of crack length at the conditions defined in the ReferenceCrack condition; required to run an AirflowNetwork simulation. The DesignBuilder Cracks template defines the flow coefficient for a tight, low-leakage wall to be 0.00001 and 0.001 for external and internal constructions, respectively. Flow coefficients for a very poor, high-leakage wall are defined to be 0.0004 and 0.019 for external and internal constructions, respectively.",
2003
+ "exclusiveMinimum": 0,
2004
+ "type": "number",
2005
+ "format": "double"
2006
+ },
2007
+ "type": {
2008
+ "title": "Type",
2009
+ "default": "AFNCrack",
2010
+ "pattern": "^AFNCrack$",
2011
+ "type": "string",
2012
+ "readOnly": true
2013
+ },
2014
+ "flow_exponent": {
2015
+ "title": "Flow Exponent",
2016
+ "description": "An optional dimensionless number between 0.5 and 1 used to calculate the crack mass flow rate; required to run an AirflowNetwork simulation. This value represents the leak geometry impact on airflow, with 0.5 generally corresponding to turbulent orifice flow and 1 generally corresponding to laminar flow. The default of 0.65 is representative of many cases of wall and window leakage, used when the exponent cannot be measured.",
2017
+ "default": 0.65,
2018
+ "minimum": 0.5,
2019
+ "maximum": 1,
2020
+ "type": "number",
2021
+ "format": "double"
2022
+ }
2023
+ },
2024
+ "required": [
2025
+ "flow_coefficient"
2026
+ ],
2027
+ "additionalProperties": false
2028
+ },
1911
2029
  "FaceEnergyPropertiesAbridged": {
1912
2030
  "title": "FaceEnergyPropertiesAbridged",
1913
2031
  "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
@@ -1926,6 +2044,15 @@
1926
2044
  "maxLength": 100,
1927
2045
  "minLength": 1,
1928
2046
  "type": "string"
2047
+ },
2048
+ "vent_crack": {
2049
+ "title": "Vent Crack",
2050
+ "description": "An optional AFNCrack to specify airflow through a surface crack used by the AirflowNetwork.",
2051
+ "allOf": [
2052
+ {
2053
+ "$ref": "#/components/schemas/AFNCrack"
2054
+ }
2055
+ ]
1929
2056
  }
1930
2057
  },
1931
2058
  "additionalProperties": false
@@ -8069,6 +8196,103 @@
8069
8196
  ],
8070
8197
  "additionalProperties": false
8071
8198
  },
8199
+ "VentilationControlType": {
8200
+ "title": "VentilationControlType",
8201
+ "description": "An enumeration.",
8202
+ "enum": [
8203
+ "SingleZone",
8204
+ "MultiZoneWithDistribution",
8205
+ "MultiZoneWithoutDistribution"
8206
+ ],
8207
+ "type": "string"
8208
+ },
8209
+ "BuildingType": {
8210
+ "title": "BuildingType",
8211
+ "description": "An enumeration.",
8212
+ "enum": [
8213
+ "LowRise",
8214
+ "HighRise"
8215
+ ],
8216
+ "type": "string"
8217
+ },
8218
+ "VentilationSimulationControl": {
8219
+ "title": "VentilationSimulationControl",
8220
+ "description": "The global parameters used in the ventilation simulation.",
8221
+ "type": "object",
8222
+ "properties": {
8223
+ "type": {
8224
+ "title": "Type",
8225
+ "default": "VentilationSimulationControl",
8226
+ "pattern": "^VentilationSimulationControl$",
8227
+ "type": "string",
8228
+ "readOnly": true
8229
+ },
8230
+ "vent_control_type": {
8231
+ "title": "Vent Control Type",
8232
+ "description": "Text indicating type of ventilation control. Choices are: SingleZone, MultiZoneWithDistribution, MultiZoneWithoutDistribution. The MultiZone options will model air flow with the AirflowNetwork model, which is generally more accurate then the SingleZone option, but will take considerably longer to simulate, and requires defining more ventilation parameters to explicitly account for weather and building-induced pressure differences, and the leakage geometry corresponding to specific windows, doors, and surface cracks.",
8233
+ "default": "SingleZone",
8234
+ "allOf": [
8235
+ {
8236
+ "$ref": "#/components/schemas/VentilationControlType"
8237
+ }
8238
+ ]
8239
+ },
8240
+ "reference_temperature": {
8241
+ "title": "Reference Temperature",
8242
+ "description": "Reference temperature measurement in Celsius under which the surface crack data were obtained.",
8243
+ "default": 20,
8244
+ "minimum": -273.15,
8245
+ "type": "number",
8246
+ "format": "double"
8247
+ },
8248
+ "reference_pressure": {
8249
+ "title": "Reference Pressure",
8250
+ "description": "Reference barometric pressure measurement in Pascals under which the surface crack data were obtained.",
8251
+ "default": 101325,
8252
+ "minimum": 31000,
8253
+ "maximum": 120000,
8254
+ "type": "number",
8255
+ "format": "double"
8256
+ },
8257
+ "reference_humidity_ratio": {
8258
+ "title": "Reference Humidity Ratio",
8259
+ "description": "Reference humidity ratio measurement in kgWater/kgDryAir under which the surface crack data were obtained.",
8260
+ "default": 0,
8261
+ "minimum": 0,
8262
+ "type": "number",
8263
+ "format": "double"
8264
+ },
8265
+ "building_type": {
8266
+ "title": "Building Type",
8267
+ "description": "Text indicating relationship between building footprint and height used to calculate the wind pressure coefficients for exterior surfaces.Choices are: LowRise and HighRise. LowRise corresponds to rectangular building whose height is less then three times the width and length of the footprint. HighRise corresponds to a rectangular building whose height is more than three times the width and length of the footprint. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.",
8268
+ "default": "LowRise",
8269
+ "allOf": [
8270
+ {
8271
+ "$ref": "#/components/schemas/BuildingType"
8272
+ }
8273
+ ]
8274
+ },
8275
+ "long_axis_angle": {
8276
+ "title": "Long Axis Angle",
8277
+ "description": "The clockwise rotation in degrees from true North of the long axis of the building. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.",
8278
+ "default": 0,
8279
+ "minimum": 0,
8280
+ "maximum": 180,
8281
+ "type": "number",
8282
+ "format": "double"
8283
+ },
8284
+ "aspect_ratio": {
8285
+ "title": "Aspect Ratio",
8286
+ "description": "Aspect ratio of a rectangular footprint, defined as the ratio of length of the short axis divided by the length of the long axis. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.",
8287
+ "default": 1,
8288
+ "exclusiveMinimum": 0,
8289
+ "maximum": 1,
8290
+ "type": "number",
8291
+ "format": "double"
8292
+ }
8293
+ },
8294
+ "additionalProperties": false
8295
+ },
8072
8296
  "ModelEnergyProperties": {
8073
8297
  "title": "ModelEnergyProperties",
8074
8298
  "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
@@ -8271,6 +8495,15 @@
8271
8495
  "items": {
8272
8496
  "$ref": "#/components/schemas/ScheduleTypeLimit"
8273
8497
  }
8498
+ },
8499
+ "ventilation_simulation_control": {
8500
+ "title": "Ventilation Simulation Control",
8501
+ "description": "An optional parameter to define the global parameters for a ventilation cooling.",
8502
+ "allOf": [
8503
+ {
8504
+ "$ref": "#/components/schemas/VentilationSimulationControl"
8505
+ }
8506
+ ]
8274
8507
  }
8275
8508
  },
8276
8509
  "additionalProperties": false
@@ -10503,6 +10736,356 @@
10503
10736
  ],
10504
10737
  "additionalProperties": false
10505
10738
  },
10739
+ "Sensor": {
10740
+ "title": "Sensor",
10741
+ "description": "A single Radiance of sensors.",
10742
+ "type": "object",
10743
+ "properties": {
10744
+ "pos": {
10745
+ "title": "Pos",
10746
+ "description": "Position of sensor in space as an array of (x, y, z) values.",
10747
+ "minItems": 3,
10748
+ "maxItems": 3,
10749
+ "type": "array",
10750
+ "items": {
10751
+ "type": "number",
10752
+ "format": "double"
10753
+ }
10754
+ },
10755
+ "dir": {
10756
+ "title": "Dir",
10757
+ "description": "Direction of sensor as an array of (x, y, z) values.",
10758
+ "minItems": 3,
10759
+ "maxItems": 3,
10760
+ "type": "array",
10761
+ "items": {
10762
+ "type": "number",
10763
+ "format": "double"
10764
+ }
10765
+ },
10766
+ "type": {
10767
+ "title": "Type",
10768
+ "default": "Sensor",
10769
+ "pattern": "^Sensor$",
10770
+ "type": "string",
10771
+ "readOnly": true
10772
+ }
10773
+ },
10774
+ "required": [
10775
+ "pos",
10776
+ "dir"
10777
+ ],
10778
+ "additionalProperties": false
10779
+ },
10780
+ "Color": {
10781
+ "title": "Color",
10782
+ "description": "A mesh in 3D space.",
10783
+ "type": "object",
10784
+ "properties": {
10785
+ "r": {
10786
+ "title": "R",
10787
+ "description": "Integer for red value.",
10788
+ "minimum": 0,
10789
+ "maximum": 255,
10790
+ "type": "integer",
10791
+ "format": "int32"
10792
+ },
10793
+ "g": {
10794
+ "title": "G",
10795
+ "description": "Integer for green value.",
10796
+ "minimum": 0,
10797
+ "maximum": 255,
10798
+ "type": "integer",
10799
+ "format": "int32"
10800
+ },
10801
+ "b": {
10802
+ "title": "B",
10803
+ "description": "Integer for blue value.",
10804
+ "minimum": 0,
10805
+ "maximum": 255,
10806
+ "type": "integer",
10807
+ "format": "int32"
10808
+ },
10809
+ "type": {
10810
+ "title": "Type",
10811
+ "default": "Color",
10812
+ "pattern": "^Color$",
10813
+ "type": "string",
10814
+ "readOnly": true
10815
+ }
10816
+ },
10817
+ "required": [
10818
+ "r",
10819
+ "g",
10820
+ "b"
10821
+ ],
10822
+ "additionalProperties": false
10823
+ },
10824
+ "Mesh3D": {
10825
+ "title": "Mesh3D",
10826
+ "description": "A mesh in 3D space.",
10827
+ "type": "object",
10828
+ "properties": {
10829
+ "vertices": {
10830
+ "title": "Vertices",
10831
+ "description": "A list of points representing the vertices of the mesh. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.",
10832
+ "minItems": 3,
10833
+ "type": "array",
10834
+ "items": {
10835
+ "type": "array",
10836
+ "items": {
10837
+ "type": "number",
10838
+ "format": "double"
10839
+ },
10840
+ "minItems": 3,
10841
+ "maxItems": 3
10842
+ }
10843
+ },
10844
+ "faces": {
10845
+ "title": "Faces",
10846
+ "description": "A list of lists with each sub-list having either 3 or 4 integers. These integers correspond to indices within the list of vertices.",
10847
+ "minItems": 1,
10848
+ "type": "array",
10849
+ "items": {
10850
+ "type": "array",
10851
+ "items": {
10852
+ "type": "integer",
10853
+ "format": "int32"
10854
+ },
10855
+ "minItems": 3,
10856
+ "maxItems": 4
10857
+ }
10858
+ },
10859
+ "type": {
10860
+ "title": "Type",
10861
+ "default": "Mesh3D",
10862
+ "pattern": "^Mesh3D$",
10863
+ "type": "string",
10864
+ "readOnly": true
10865
+ },
10866
+ "colors": {
10867
+ "title": "Colors",
10868
+ "description": "An optional list of colors that correspond to either the faces of the mesh or the vertices of the mesh.",
10869
+ "type": "array",
10870
+ "items": {
10871
+ "$ref": "#/components/schemas/Color"
10872
+ }
10873
+ }
10874
+ },
10875
+ "required": [
10876
+ "vertices",
10877
+ "faces"
10878
+ ],
10879
+ "additionalProperties": false
10880
+ },
10881
+ "SensorGrid": {
10882
+ "title": "SensorGrid",
10883
+ "description": "A grid of sensors.",
10884
+ "type": "object",
10885
+ "properties": {
10886
+ "identifier": {
10887
+ "title": "Identifier",
10888
+ "description": "Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.",
10889
+ "type": "string"
10890
+ },
10891
+ "sensors": {
10892
+ "title": "Sensors",
10893
+ "description": "A list of sensors that belong to the grid.",
10894
+ "type": "array",
10895
+ "items": {
10896
+ "$ref": "#/components/schemas/Sensor"
10897
+ }
10898
+ },
10899
+ "display_name": {
10900
+ "title": "Display Name",
10901
+ "description": "Text string for a unique display name, used to set the default file name that the radiance asset is written to within a radiance folder. Must not contain spaces or special characters.",
10902
+ "type": "string"
10903
+ },
10904
+ "room_identifier": {
10905
+ "title": "Room Identifier",
10906
+ "description": "Optional text string for the Room identifier to which this object belongs. This will be used to narrow down the number of aperture groups that have to be run with this sensor grid. If None, the grid will be run with all aperture groups in the model.",
10907
+ "maxLength": 100,
10908
+ "minLength": 1,
10909
+ "pattern": "[A-Za-z0-9_-]",
10910
+ "type": "string"
10911
+ },
10912
+ "light_path": {
10913
+ "title": "Light Path",
10914
+ "description": "Get or set a list of lists for the light path from the object to the sky. Each sub-list contains identifiers of aperture groups through which light passes. (eg. [[\"SouthWindow1\"], [\"static_apertures\", \"NorthWindow2\"]]).Setting this property will override any auto-calculation of the light path from the model and room_identifier upon export to the simulation.",
10915
+ "type": "array",
10916
+ "items": {
10917
+ "type": "array",
10918
+ "items": {
10919
+ "type": "string"
10920
+ }
10921
+ }
10922
+ },
10923
+ "type": {
10924
+ "title": "Type",
10925
+ "default": "SensorGrid",
10926
+ "pattern": "^SensorGrid$",
10927
+ "type": "string",
10928
+ "readOnly": true
10929
+ },
10930
+ "mesh": {
10931
+ "title": "Mesh",
10932
+ "description": "An optional Mesh3D that aligns with the sensors and can be used for visualization of the grid. Note that the number of sensors in the grid must match the number of faces or the number vertices within the Mesh3D.",
10933
+ "allOf": [
10934
+ {
10935
+ "$ref": "#/components/schemas/Mesh3D"
10936
+ }
10937
+ ]
10938
+ }
10939
+ },
10940
+ "required": [
10941
+ "identifier",
10942
+ "sensors"
10943
+ ],
10944
+ "additionalProperties": false
10945
+ },
10946
+ "ViewType": {
10947
+ "title": "ViewType",
10948
+ "description": "A single character for the view type (-vt).",
10949
+ "enum": [
10950
+ "v",
10951
+ "h",
10952
+ "l",
10953
+ "c",
10954
+ "a",
10955
+ "s"
10956
+ ],
10957
+ "type": "string"
10958
+ },
10959
+ "View": {
10960
+ "title": "View",
10961
+ "description": "A single Radiance of sensors.",
10962
+ "type": "object",
10963
+ "properties": {
10964
+ "identifier": {
10965
+ "title": "Identifier",
10966
+ "description": "Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.",
10967
+ "type": "string"
10968
+ },
10969
+ "position": {
10970
+ "title": "Position",
10971
+ "description": "The view position (-vp) as an array of (x, y, z) values.This is the focal point of a perspective view or the center of a parallel projection.",
10972
+ "minItems": 3,
10973
+ "maxItems": 3,
10974
+ "type": "array",
10975
+ "items": {
10976
+ "type": "number",
10977
+ "format": "double"
10978
+ }
10979
+ },
10980
+ "direction": {
10981
+ "title": "Direction",
10982
+ "description": "The view direction (-vd) as an array of (x, y, z) values.The length of this vector indicates the focal distance as needed by the pixel depth of field (-pd) in rpict.",
10983
+ "minItems": 3,
10984
+ "maxItems": 3,
10985
+ "type": "array",
10986
+ "items": {
10987
+ "type": "number",
10988
+ "format": "double"
10989
+ }
10990
+ },
10991
+ "up_vector": {
10992
+ "title": "Up Vector",
10993
+ "description": "The view up (-vu) vector as an array of (x, y, z) values.",
10994
+ "minItems": 3,
10995
+ "maxItems": 3,
10996
+ "type": "array",
10997
+ "items": {
10998
+ "type": "number",
10999
+ "format": "double"
11000
+ }
11001
+ },
11002
+ "display_name": {
11003
+ "title": "Display Name",
11004
+ "description": "Text string for a unique display name, used to set the default file name that the radiance asset is written to within a radiance folder. Must not contain spaces or special characters.",
11005
+ "type": "string"
11006
+ },
11007
+ "room_identifier": {
11008
+ "title": "Room Identifier",
11009
+ "description": "Optional text string for the Room identifier to which this object belongs. This will be used to narrow down the number of aperture groups that have to be run with this sensor grid. If None, the grid will be run with all aperture groups in the model.",
11010
+ "maxLength": 100,
11011
+ "minLength": 1,
11012
+ "pattern": "[A-Za-z0-9_-]",
11013
+ "type": "string"
11014
+ },
11015
+ "light_path": {
11016
+ "title": "Light Path",
11017
+ "description": "Get or set a list of lists for the light path from the object to the sky. Each sub-list contains identifiers of aperture groups through which light passes. (eg. [[\"SouthWindow1\"], [\"static_apertures\", \"NorthWindow2\"]]).Setting this property will override any auto-calculation of the light path from the model and room_identifier upon export to the simulation.",
11018
+ "type": "array",
11019
+ "items": {
11020
+ "type": "array",
11021
+ "items": {
11022
+ "type": "string"
11023
+ }
11024
+ }
11025
+ },
11026
+ "type": {
11027
+ "title": "Type",
11028
+ "default": "View",
11029
+ "pattern": "^View$",
11030
+ "type": "string",
11031
+ "readOnly": true
11032
+ },
11033
+ "view_type": {
11034
+ "title": "View Type",
11035
+ "default": "v",
11036
+ "allOf": [
11037
+ {
11038
+ "$ref": "#/components/schemas/ViewType"
11039
+ }
11040
+ ]
11041
+ },
11042
+ "h_size": {
11043
+ "title": "H Size",
11044
+ "description": "A number for the horizontal field of view in degrees (for all perspective projections including fisheye). For a parallel projection, this is the view width in world coordinates.",
11045
+ "default": 60,
11046
+ "type": "number",
11047
+ "format": "double"
11048
+ },
11049
+ "v_size": {
11050
+ "title": "V Size",
11051
+ "description": "A number for the vertical field of view in degrees (for all perspective projections including fisheye). For a parallel projection, this is the view width in world coordinates.",
11052
+ "default": 60,
11053
+ "type": "number",
11054
+ "format": "double"
11055
+ },
11056
+ "shift": {
11057
+ "title": "Shift",
11058
+ "description": "The view shift (-vs). This is the amount the actual image will be shifted to the right of the specified view. This option is useful for generating skewed perspectives or rendering an image a piece at a time. A value of 1 means that the rendered image starts just to the right of the normal view. A value of -1 would be to the left. Larger or fractional values are permitted as well.",
11059
+ "type": "number",
11060
+ "format": "double"
11061
+ },
11062
+ "lift": {
11063
+ "title": "Lift",
11064
+ "description": "The view lift (-vl). This is the amount the actual image will be lifted up from the specified view. This option is useful for generating skewed perspectives or rendering an image a piece at a time. A value of 1 means that the rendered image starts just to the right of the normal view. A value of -1 would be to the left. Larger or fractional values are permitted as well.",
11065
+ "type": "number",
11066
+ "format": "double"
11067
+ },
11068
+ "fore_clip": {
11069
+ "title": "Fore Clip",
11070
+ "description": "View fore clip (-vo) at a distance from the view point.The plane will be perpendicular to the view direction for perspective and parallel view types. For fisheye view types, the clipping plane is actually a clipping sphere, centered on the view point with fore_clip radius. Objects in front of this imaginary surface will not be visible.",
11071
+ "type": "number",
11072
+ "format": "double"
11073
+ },
11074
+ "aft_clip": {
11075
+ "title": "Aft Clip",
11076
+ "description": "View aft clip (-va) at a distance from the view point.Like the view fore plane, it will be perpendicular to the view direction for perspective and parallel view types. For fisheye view types, the clipping plane is actually a clipping sphere, centered on the view point with radius val.",
11077
+ "type": "number",
11078
+ "format": "double"
11079
+ }
11080
+ },
11081
+ "required": [
11082
+ "identifier",
11083
+ "position",
11084
+ "direction",
11085
+ "up_vector"
11086
+ ],
11087
+ "additionalProperties": false
11088
+ },
10506
11089
  "ModelRadianceProperties": {
10507
11090
  "title": "ModelRadianceProperties",
10508
11091
  "description": "Radiance Properties for Honeybee Model.",
@@ -10517,7 +11100,7 @@
10517
11100
  },
10518
11101
  "modifiers": {
10519
11102
  "title": "Modifiers",
10520
- "description": "A list of all unique modifiers in the model. This includes modifiers across all Faces, Apertures, Doors, Shades, Room ModifierSets, and the global_modifier_set (default: None).",
11103
+ "description": "A list of all unique modifiers in the model. This includes modifiers across all Faces, Apertures, Doors, Shades, Room ModifierSets, and the global_modifier_set.",
10521
11104
  "type": "array",
10522
11105
  "items": {
10523
11106
  "anyOf": [
@@ -10553,7 +11136,7 @@
10553
11136
  },
10554
11137
  "modifier_sets": {
10555
11138
  "title": "Modifier Sets",
10556
- "description": "A list of all unique Room-Assigned ModifierSets in the Model (default: None).",
11139
+ "description": "A list of all unique Room-Assigned ModifierSets in the Model.",
10557
11140
  "type": "array",
10558
11141
  "items": {
10559
11142
  "anyOf": [
@@ -10565,6 +11148,22 @@
10565
11148
  }
10566
11149
  ]
10567
11150
  }
11151
+ },
11152
+ "sensor_grids": {
11153
+ "title": "Sensor Grids",
11154
+ "description": "An array of SensorGrids that are associated with the model.",
11155
+ "type": "array",
11156
+ "items": {
11157
+ "$ref": "#/components/schemas/SensorGrid"
11158
+ }
11159
+ },
11160
+ "views": {
11161
+ "title": "Views",
11162
+ "description": "An array of Views that are associated with the model.",
11163
+ "type": "array",
11164
+ "items": {
11165
+ "$ref": "#/components/schemas/View"
11166
+ }
10568
11167
  }
10569
11168
  },
10570
11169
  "additionalProperties": false