From b1761e883ee1f0a93b26d36cfebcdd0c040a9796 Mon Sep 17 00:00:00 2001 From: Chris Mackey Date: Wed, 3 Jul 2024 11:03:27 -0700 Subject: [PATCH] fix(doe2): Document the new optional Room space_polygon_geometry --- honeybee_schema/doe2/properties.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/honeybee_schema/doe2/properties.py b/honeybee_schema/doe2/properties.py index 6e21b90..e604431 100644 --- a/honeybee_schema/doe2/properties.py +++ b/honeybee_schema/doe2/properties.py @@ -4,6 +4,7 @@ from .._base import NoExtraBaseModel from ..altnumber import Autocalculate +from ..geometry import Face3D class RoomDoe2Properties(NoExtraBaseModel): @@ -57,6 +58,16 @@ class RoomDoe2Properties(NoExtraBaseModel): 'not be written into the INP.' ) + space_polygon_geometry: Face3D = Field( + default=None, + description='An optional horizontal Face3D object, which will ' + 'be used to set the SPACE polygon during export to INP. If None, ' + 'the SPACE polygon is auto-calculated from the 3D Room geometry. ' + 'Specifying a geometry here can help overcome some limitations of ' + 'this auto-calculation, particularly for cases where the floors ' + 'of the Room are composed of AirBoundaries.' + ) + class ModelDoe2Properties(NoExtraBaseModel):