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

dragonfly_schema/doe2/properties.py

@@ -0,0 +1,64 @@
+"""Model DOE-2 properties."""
+from pydantic import Field, constr
+from typing import Union
+
+from honeybee_schema._base import NoExtraBaseModel
+from honeybee_schema.altnumber import Autocalculate
+
+
+class Room2DDoe2Properties(NoExtraBaseModel):
+
+    type: constr(regex='^Room2DDoe2Properties$') = \
+        'Room2DDoe2Properties'
+
+    assigned_flow: Union[Autocalculate, float] = Field(
+        Autocalculate(),
+        ge=0,
+        description='A number for the design supply air flow rate for the zone '
+        'the Room is assigned to (cfm). This establishes the minimum allowed '
+        'design air flow. Note that the actual design flow may be larger. If '
+        'Autocalculate, this parameter will not be written into the INP.'
+    )
+
+    flow_per_area: Union[Autocalculate, float] = Field(
+        Autocalculate(),
+        ge=0,
+        description='A number for the design supply air flow rate to the zone '
+        'per unit floor area (cfm/ft2). If Autocalculate, this parameter will '
+        'not be written into the INP.'
+    )
+
+    min_flow_ratio: Union[Autocalculate, float] = Field(
+        Autocalculate(),
+        ge=0,
+        le=1,
+        description='A number between 0 and 1 for the minimum allowable zone '
+        'air supply flow rate, expressed as a fraction of design flow rate. Applicable '
+        'to variable-volume type systems only. If Autocalculate, this parameter will '
+        'not be written into the INP.'
+    )
+
+    min_flow_per_area: Union[Autocalculate, float] = Field(
+        Autocalculate(),
+        ge=0,
+        description='A number for the minimum air flow per square foot of '
+        'floor area (cfm/ft2). This is an alternative way of specifying the '
+        'min_flow_ratio. If Autocalculate, this parameter will not be written '
+        'into the INP.'
+    )
+
+    hmax_flow_ratio: Union[Autocalculate, float] = Field(
+        Autocalculate(),
+        ge=0,
+        le=1,
+        description='A number between 0 and 1 for the ratio of the maximum (or fixed) '
+        'heating airflow to the cooling airflow. The specific meaning varies according '
+        'to the type of zone terminal. If Autocalculate, this parameter will '
+        'not be written into the INP.'
+    )
+
+
+class ModelDoe2Properties(NoExtraBaseModel):
+
+    type: constr(regex='^ModelDoe2Properties$') = \
+        'ModelDoe2Properties'

dragonfly_schema/model.py

@@ -22,6 +22,7 @@ from .energy.properties import Room2DEnergyPropertiesAbridged, \
 from .radiance.properties import Room2DRadiancePropertiesAbridged, \
     StoryRadiancePropertiesAbridged, BuildingRadiancePropertiesAbridged, \
     ContextShadeRadiancePropertiesAbridged, ModelRadianceProperties
+from .doe2.properties import Room2DDoe2Properties, ModelDoe2Properties
 from .comparison.properties import Room2DComparisonProperties, ModelComparisonProperties
 
 
@@ -37,6 +38,10 @@ class Room2DPropertiesAbridged(BaseModel):
         default=None
     )
 
+    doe2: Room2DDoe2Properties = Field(
+        default=None
+    )
+
     comparison: Room2DComparisonProperties = Field(
         default=None
     )
@@ -123,6 +128,15 @@ class Room2D(IDdBaseModel):
         'Setting this to zero indicates that the room has no floor plenum.'
     )
 
+    zone: str = Field(
+        default=None,
+        description='Text string for for the zone identifier to which this Room2D '
+        ' belongs. Room2Ds sharing the same zone identifier are considered part of the '
+        'same zone in a Building. If the zone identifier has not been specified, it will '
+        'be the same as the Room2D identifier in the destination engine. Note that this '
+        'property has no character restrictions.'
+    )
+
     boundary_conditions: List[
         Union[Ground, Outdoors, Surface, Adiabatic, OtherSideTemperature]
     ] = Field(
@@ -403,6 +417,10 @@ class ModelProperties(BaseModel):
         default=None
     )
 
+    doe2: ModelDoe2Properties = Field(
+        default=None
+    )
+
     comparison: ModelComparisonProperties = Field(
         default=None
     )

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dragonfly-schema
-Version: 1.14.0
+Version: 1.15.0
 Summary: Dragonfly Data-Model Objects
 Home-page: https://github.com/ladybug-tools/dragonfly-schema
 Author: Ladybug Tools
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: honeybee-schema==1.58.6
+Requires-Dist: honeybee-schema==1.59.0
 
 [![Build Status](https://travis-ci.com/ladybug-tools/dragonfly-schema.svg?branch=master)](https://travis-ci.com/ladybug-tools/dragonfly-schema)
 [![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-schema/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-schema)

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

@@ -1,18 +1,20 @@
 dragonfly_schema/__init__.py,sha256=Cp-YAOlfQuotiRooL-u9oPbSK_C4xBDYQUhlA67qxyI,36
-dragonfly_schema/model.py,sha256=USQuUKjbs-X0s1Mwj-T18AEWetmH6tldwZS-rJXgDZA,18362
+dragonfly_schema/model.py,sha256=QnIBRNbdKWODGdmbdKffPLwzOPK-mY2PTACMzMFDqJ4,19024
 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/doe2/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dragonfly_schema/doe2/properties.py,sha256=lT5Ca_aH3jvwWNNRAxxEu3NLnQIGImv33FHltL2WDiQ,2361
 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.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,,
+dragonfly_schema-1.15.0.dist-info/LICENSE,sha256=XfAFIvGuzrC7DEE82mZyAJX4l2ND-i7fICCCMiXBDZw,1070
+dragonfly_schema-1.15.0.dist-info/METADATA,sha256=dxPQGeZVIlZJwaQ23_to5BWe3dZcF6hgCih8-XjS-p8,1943
+dragonfly_schema-1.15.0.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
+dragonfly_schema-1.15.0.dist-info/top_level.txt,sha256=FOvFqYP_bZgcwNtIIgvUZjC-LuQGBEms5zW4nkiclZ0,17
+dragonfly_schema-1.15.0.dist-info/RECORD,,