dragonfly-schema 1.13.0__py2.py3-none-any.whl → 1.14.0__py2.py3-none-any.whl

dragonfly_schema/comparison/__init__.py

@@ -0,0 +1 @@
+"""Dragonfly objects specific to comparison with other models."""

dragonfly_schema/comparison/properties.py

@@ -0,0 +1,56 @@
+"""Model comparison properties."""
+from pydantic import Field, constr, conlist
+from typing import List, Union
+
+from honeybee_schema._base import NoExtraBaseModel
+
+from ..window_parameter import SingleWindow, SimpleWindowArea, SimpleWindowRatio, \
+    RepeatingWindowRatio, RectangularWindows, DetailedWindows
+from ..skylight_parameter import GriddedSkylightArea, GriddedSkylightRatio, \
+    DetailedSkylights
+
+
+class Room2DComparisonProperties(NoExtraBaseModel):
+
+    type: constr(regex='^Room2DComparisonProperties$') = \
+        'Room2DComparisonProperties'
+
+    floor_boundary: List[conlist(float, min_items=2, max_items=2)] = Field(
+        None,
+        min_items=3,
+        description='A list of 2D points representing the outer boundary vertices of '
+        'the Room2D to which the host Room2D is being compared. The list should '
+        'include at least 3 points and each point should be a list of 2 (x, y) values.'
+    )
+
+    floor_holes: List[conlist(conlist(float, min_items=2, max_items=2), min_items=3)] \
+        = Field(
+        None,
+        description='Optional list of lists with one list for each hole in the floor '
+        'plate of the Room2D to which the host Room2D is being compared. Each hole '
+        'should be a list of at least 2 points and each point a list '
+        'of 2 (x, y) values. If None, it will be assumed that there are no '
+        'holes in the floor plate.'
+    )
+
+    comparison_windows: List[Union[
+        None, SingleWindow, SimpleWindowArea, SimpleWindowRatio, RepeatingWindowRatio,
+        RectangularWindows, DetailedWindows
+    ]] = Field(
+        default=None,
+        description='A list of WindowParameter objects that dictate the window '
+        'geometries of the Room2D to which the host Room2D is being compared.'
+    )
+
+    comparison_skylight: Union[
+        None, GriddedSkylightArea, GriddedSkylightRatio, DetailedSkylights
+    ] = Field(
+        default=None,
+        description='A SkylightParameter object for the Room2D to which the host '
+        'Room2D is being compared.'
+    )
+
+
+class ModelComparisonProperties(NoExtraBaseModel):
+
+    type: constr(regex='^ModelComparisonProperties$') = 'ModelComparisonProperties'

dragonfly_schema/model.py

@@ -22,6 +22,7 @@ from .energy.properties import Room2DEnergyPropertiesAbridged, \
 from .radiance.properties import Room2DRadiancePropertiesAbridged, \
     StoryRadiancePropertiesAbridged, BuildingRadiancePropertiesAbridged, \
     ContextShadeRadiancePropertiesAbridged, ModelRadianceProperties
+from .comparison.properties import Room2DComparisonProperties, ModelComparisonProperties
 
 
 class Room2DPropertiesAbridged(BaseModel):
@@ -36,6 +37,10 @@ class Room2DPropertiesAbridged(BaseModel):
         default=None
     )
 
+    comparison: Room2DComparisonProperties = Field(
+        default=None
+    )
+
 
 class Room2D(IDdBaseModel):
 
@@ -98,6 +103,7 @@ class Room2D(IDdBaseModel):
 
     ceiling_plenum_depth: float = Field(
         0,
+        ge=0,
         description='A number for the depth that a ceiling plenum extends into '
         'the room. Setting this to a positive value will result in a separate '
         'plenum room being split off of the Room2D volume during translation '
@@ -108,6 +114,7 @@ class Room2D(IDdBaseModel):
 
     floor_plenum_depth: float = Field(
         0,
+        ge=0,
         description='A number for the depth that a floor plenum extends into '
         'the room. Setting this to a positive value will result in a separate '
         'plenum room being split off of the Room2D volume during translation '
@@ -396,6 +403,10 @@ class ModelProperties(BaseModel):
         default=None
     )
 
+    comparison: ModelComparisonProperties = Field(
+        default=None
+    )
+
 
 class Model(IDdBaseModel):
 

{dragonfly_schema-1.13.0.dist-info → dragonfly_schema-1.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dragonfly-schema
-Version: 1.13.0
+Version: 1.14.0
 Summary: Dragonfly Data-Model Objects
 Home-page: https://github.com/ladybug-tools/dragonfly-schema
 Author: Ladybug Tools

{dragonfly_schema-1.13.0.dist-info → dragonfly_schema-1.14.0.dist-info}/RECORD

@@ -1,16 +1,18 @@
 dragonfly_schema/__init__.py,sha256=Cp-YAOlfQuotiRooL-u9oPbSK_C4xBDYQUhlA67qxyI,36
-dragonfly_schema/model.py,sha256=1KCbgcRIOiPk3hfZFT8vQlVNEEHcKNdlWQ4Qw1CL6-A,18086
+dragonfly_schema/model.py,sha256=USQuUKjbs-X0s1Mwj-T18AEWetmH6tldwZS-rJXgDZA,18362
 dragonfly_schema/roof.py,sha256=A4cYdKrx01lqlBrPzAOwAO4jtEh9JdD46tB9wSW2p6w,746
 dragonfly_schema/shading_parameter.py,sha256=WI9XPX3eVXhIutvE_AD1ozJ4QxH85E3Frv9SKsIzCl8,3121
 dragonfly_schema/skylight_parameter.py,sha256=4uxsAHHEbpfZYndIw2KcQ9AJXU7AJcRZWo7up65vC2c,3137
 dragonfly_schema/window_parameter.py,sha256=nC1Q1E82sNjPLcsHOwZ0xh011NylLotmkCX12AFc_74,10871
+dragonfly_schema/comparison/__init__.py,sha256=3JoPhHkbxdrNFp0vfU8QX_HGYzPQhV8LSgVL1z7W09g,66
+dragonfly_schema/comparison/properties.py,sha256=H-nVUVhvMtKAeqpRlgDpLDzrxFfuaMLp87FJUrB4TDQ,2197
 dragonfly_schema/energy/__init__.py,sha256=lLuzq9Sm9LUrW6VpOYxfS0Q_rXzOJoPDfzlxA3eFq2M,55
 dragonfly_schema/energy/properties.py,sha256=d_0hPXWifkFSCXaIbOD0OFc4-pYPcGERUEnINz5q-Jw,9828
 dragonfly_schema/radiance/__init__.py,sha256=ok8w16ru1XXBUVjdghvNvwwXGPVSKKpHU-nmj4mf3IU,57
 dragonfly_schema/radiance/gridpar.py,sha256=ZQTnEdN1vmSsa2QMxfUdebg3cMnu6VvfcluiP11xHOs,4809
 dragonfly_schema/radiance/properties.py,sha256=Q_O_7fJohdtv5uwHTCZp1W67LoNUaZ45GB6GK7zKK4Y,3405
-dragonfly_schema-1.13.0.dist-info/LICENSE,sha256=XfAFIvGuzrC7DEE82mZyAJX4l2ND-i7fICCCMiXBDZw,1070
-dragonfly_schema-1.13.0.dist-info/METADATA,sha256=IcTgPxuuObEO8xom80v5VaIHMEQjDA_Tuh0bNCTmE9o,1943
-dragonfly_schema-1.13.0.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
-dragonfly_schema-1.13.0.dist-info/top_level.txt,sha256=FOvFqYP_bZgcwNtIIgvUZjC-LuQGBEms5zW4nkiclZ0,17
-dragonfly_schema-1.13.0.dist-info/RECORD,,
+dragonfly_schema-1.14.0.dist-info/LICENSE,sha256=XfAFIvGuzrC7DEE82mZyAJX4l2ND-i7fICCCMiXBDZw,1070
+dragonfly_schema-1.14.0.dist-info/METADATA,sha256=mAd64KwP2vZ9Ep9dz45bGzVzg3xmzqeixKXfw3DgTjM,1943
+dragonfly_schema-1.14.0.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
+dragonfly_schema-1.14.0.dist-info/top_level.txt,sha256=FOvFqYP_bZgcwNtIIgvUZjC-LuQGBEms5zW4nkiclZ0,17
+dragonfly_schema-1.14.0.dist-info/RECORD,,