honeybee-schema 1.57.2__tar.gz → 1.58.0__tar.gz

{honeybee-schema-1.57.2 → honeybee-schema-1.58.0}/.github/workflows/ci.yaml

@@ -9,7 +9,7 @@ jobs:
     name: Unit tests
     strategy:
       matrix:
-        python-version: ['3.7', '3.10']
+        python-version: ['3.10']
         os: [macos-latest, ubuntu-latest, windows-latest]
 
     runs-on: ${{ matrix.os }}

{honeybee-schema-1.57.2/honeybee_schema.egg-info → honeybee-schema-1.58.0}/PKG-INFO

@@ -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.58.0/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-1.57.2 → honeybee-schema-1.58.0}/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-1.57.2 → honeybee-schema-1.58.0}/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 → honeybee-schema-1.58.0/honeybee_schema.egg-info}/PKG-INFO

@@ -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 → honeybee-schema-1.58.0}/honeybee_schema.egg-info/SOURCES.txt

@@ -38,6 +38,8 @@ honeybee_schema.egg-info/dependency_links.txt
 honeybee_schema.egg-info/entry_points.txt
 honeybee_schema.egg-info/requires.txt
 honeybee_schema.egg-info/top_level.txt
+honeybee_schema/doe2/__init__.py
+honeybee_schema/doe2/properties.py
 honeybee_schema/energy/__init__.py
 honeybee_schema/energy/_base.py
 honeybee_schema/energy/construction.py