honeybee-schema 1.57.2__py2.py3-none-any.whl → 1.58.0__py2.py3-none-any.whl

honeybee_schema/doe2/properties.py

@@ -0,0 +1,64 @@
+"""Model DOE-2 properties."""
+from pydantic import Field, constr
+from typing import Union
+
+from .._base import NoExtraBaseModel
+from ..altnumber import Autocalculate
+
+
+class RoomDoe2Properties(NoExtraBaseModel):
+
+    type: constr(regex='^RoomDoe2Properties$') = \
+        'RoomDoe2Properties'
+
+    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'

honeybee_schema/energy/load.py

@@ -472,6 +472,26 @@ class SetpointAbridged(IDdEnergyBaseModel):
         'The values in this schedule should be in [%].'
     )
 
+    setpoint_cutout_difference: float = Field(
+        0,
+        ge=0,
+        description='An optional positive number for the temperature '
+        'difference between the cutout temperature and the setpoint temperature. '
+        'Specifying a non-zero number here is useful for modeling the throttling '
+        'range associated with a given setup of setpoint controls and HVAC equipment. '
+        'Throttling ranges describe the range where a zone is slightly over-cooled '
+        'or over-heated beyond the thermostat setpoint. They are used to avoid '
+        'situations where HVAC systems turn on only to turn off a few minutes later, '
+        'thereby wearing out the parts of mechanical systems faster. They can '
+        'have a minor impact on energy consumption and can often have significant '
+        'impacts on occupant thermal comfort, though using the default value '
+        'of zero will often yield results that are close enough when trying '
+        'to estimate the annual heating/cooling energy use. Specifying a value '
+        'of zero effectively assumes that the system will turn on whenever '
+        'conditions are outside the setpoint range and will cut out as soon '
+        'as the setpoint is reached.'
+    )
+
     @root_validator
     def check_both_humid_sch(cls, values):
         "Ensure that the other humidity schedule is included when one is."

honeybee_schema/model.py

@@ -16,6 +16,8 @@ from .radiance.properties import ShadeRadiancePropertiesAbridged, \
     FaceRadiancePropertiesAbridged, RoomRadiancePropertiesAbridged, \
     ModelRadianceProperties, ShadeMeshRadiancePropertiesAbridged
 
+from .doe2.properties import RoomDoe2Properties, ModelDoe2Properties
+
 from .geometry import Face3D, Mesh3D
 
 
@@ -294,6 +296,10 @@ class RoomPropertiesAbridged(BaseModel):
         default=None
     )
 
+    doe2: RoomDoe2Properties = Field(
+        default=None
+    )
+
 
 class Room(IDdBaseModel):
 
@@ -368,6 +374,10 @@ class ModelProperties(BaseModel):
         default=None
     )
 
+    doe2: ModelDoe2Properties = Field(
+        default=None
+    )
+
 
 class Model(IDdBaseModel):
 

{honeybee_schema-1.57.2.dist-info → honeybee_schema-1.58.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-schema
-Version: 1.57.2
+Version: 1.58.0
 Summary: Honeybee Data-Model Objects
 Home-page: https://github.com/ladybug-tools-in2/honeybee-schema
 Author: Ladybug Tools

{honeybee_schema-1.57.2.dist-info → honeybee_schema-1.58.0.dist-info}/RECORD

@@ -6,9 +6,11 @@ honeybee_schema/boundarycondition.py,sha256=hY6Oem5zNpnr42owbEzy3GIdfqvZJ4nme0qO
 honeybee_schema/cli.py,sha256=QhhgNsgz55FBmJuHrg16nQoEmzD9ZIL6ugD2lofQqMg,4387
 honeybee_schema/comparison.py,sha256=I2CCDmPLl-awBhGkSVd8b9yZncn8u2wUE-wBePrbB3c,8006
 honeybee_schema/geometry.py,sha256=7oJQXdYYd3qECmIlKh7-XcwCibs1c2eLAS_SItJ7N10,4203
-honeybee_schema/model.py,sha256=fAxHgQOQAzIM_6kV8KYayIBL-K_ST_yJWwUeyhgVmY0,13994
+honeybee_schema/model.py,sha256=4rQv8L0_9YmGExWHY7o_PAYBwthZHguAiAgRNbP2TpU,14197
 honeybee_schema/projectinfo.py,sha256=Jz9FYNSpWS282o4uNQxcL1Mo2J-fKT0gqBckk5h-Cio,2759
 honeybee_schema/validation.py,sha256=7EutKXshjqCffXCDOBxIzxpKQU_Nio1_SbLidPB_-p4,7060
+honeybee_schema/doe2/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+honeybee_schema/doe2/properties.py,sha256=qQIJv4c6jc6LQP8gTX33_Fz-oAYA3qJxhHom1EF6sas,2327
 honeybee_schema/energy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 honeybee_schema/energy/_base.py,sha256=drAW-DguuwB2ahBGG1lboGcfJKJESnXjyAWicMtjQ-U,2305
 honeybee_schema/energy/construction.py,sha256=1HldU4TO5vy4y4oCFt7GPsLBRaOJSbDPQgQX6OrWsWU,12742
@@ -18,7 +20,7 @@ honeybee_schema/energy/designday.py,sha256=as5OCxNAqU549NRlCQms10X1ylFr-oayTKH0w
 honeybee_schema/energy/generator.py,sha256=ap36GHtwkKTbJJV5SOP_bDSy4vm8hEU92BYQhK-nmrQ,7002
 honeybee_schema/energy/global_constructionset.py,sha256=Dym_36OPtxSJof0_UMDB98zDio6ubh56j9nfbWIk6_c,4958
 honeybee_schema/energy/internalmass.py,sha256=QBHGnoem9ZxwoU7Dii02HGCPDJt13Q6yIMEU9vcdZPc,771
-honeybee_schema/energy/load.py,sha256=MPvOQdv5HzimlLjW9v5IzaJy-AKQwczZxXwjfnYmLls,19952
+honeybee_schema/energy/load.py,sha256=E106Pn-fn_4qCW8M1Y9RX6rG9iBeu0k7MY9x-dJi_3Q,21204
 honeybee_schema/energy/material.py,sha256=vdfvTaTpMRDoomzb91ujLdbxOxFY_pHdTfXxiNbD91k,28276
 honeybee_schema/energy/programtype.py,sha256=1keIS_BX8pKSUtjE4PJ1PP-Tbs5KQVwtsQ0RNdiACUE,4307
 honeybee_schema/energy/properties.py,sha256=W8gBBGKKSnsKivG38QEe07vHk3zhwZ7sqVeNU5ewJV0,15074
@@ -47,9 +49,9 @@ honeybee_schema/updater/version_1_40_1.py,sha256=Fx70M8H9HZ_apCkdFn6njEd6lG9ZWrl
 honeybee_schema/updater/version_1_43_1.py,sha256=0kZ1z7MzBhToljgOUCGWaTW1mq2F72oS39jn9sEf5mU,932
 honeybee_schema/updater/version_1_43_2.py,sha256=XnPCdpjVN3hFzZqIIEjX4BYTtCxuIYCuO96n_y64aVw,617
 honeybee_schema/updater/version_1_43_5.py,sha256=ci790Qh7xtRtgMj_RdldBXCScwiBkvMt2K1Mpe7oWQE,499
-honeybee_schema-1.57.2.dist-info/LICENSE,sha256=EwA6Jt85TmMNyAsFb5GWv-tZ0vGYo8hZHBMcI391qjw,1709
-honeybee_schema-1.57.2.dist-info/METADATA,sha256=KjmtIg2cOL_ccBfBJb0bt1QjnjSeMAED9yr2VLJFSOA,2505
-honeybee_schema-1.57.2.dist-info/WHEEL,sha256=unfA4MOaH0icIyIA5oH6E2sn2Hq5zKtLlHsWapZGwes,110
-honeybee_schema-1.57.2.dist-info/entry_points.txt,sha256=suHpy6-iPhAylFCa-KopQHRJIwLhTCIVO2NHMzdEn8M,61
-honeybee_schema-1.57.2.dist-info/top_level.txt,sha256=rTScYvlcOBkdc0is-F6Q3tRkmy-vf4bMTJGXzsxI2sA,16
-honeybee_schema-1.57.2.dist-info/RECORD,,
+honeybee_schema-1.58.0.dist-info/LICENSE,sha256=EwA6Jt85TmMNyAsFb5GWv-tZ0vGYo8hZHBMcI391qjw,1709
+honeybee_schema-1.58.0.dist-info/METADATA,sha256=qJhhaYZEbIlDX-c7Mz2xSCkQS58trKPBOy_EFW2_i6s,2505
+honeybee_schema-1.58.0.dist-info/WHEEL,sha256=unfA4MOaH0icIyIA5oH6E2sn2Hq5zKtLlHsWapZGwes,110
+honeybee_schema-1.58.0.dist-info/entry_points.txt,sha256=suHpy6-iPhAylFCa-KopQHRJIwLhTCIVO2NHMzdEn8M,61
+honeybee_schema-1.58.0.dist-info/top_level.txt,sha256=rTScYvlcOBkdc0is-F6Q3tRkmy-vf4bMTJGXzsxI2sA,16
+honeybee_schema-1.58.0.dist-info/RECORD,,