honeybee-schema 1.59.1__py3-none-any.whl

honeybee_schema/radiance/modifierset.py

@@ -0,0 +1,296 @@
+"""ModifierSet Schema"""
+from pydantic import Field, constr
+from .._base import NoExtraBaseModel
+from ._base import IDdRadianceBaseModel
+from .modifier import _REFERENCE_UNION_MODIFIERS
+
+
+class BaseModifierSetAbridged(NoExtraBaseModel):
+    """Base class for the abridged modifier sets assigned to Faces."""
+
+    exterior_modifier: str = Field(
+        default=None,
+        description='Identifier for a radiance modifier object for faces with an '
+                    ' Outdoors boundary condition.'
+    )
+
+    interior_modifier: str = Field(
+        default=None,
+        description='Identifier for a radiance modifier object for faces with a '
+                    'boundary condition other than Outdoors.'
+    )
+
+
+class WallModifierSetAbridged(BaseModifierSetAbridged):
+    """Abridged set containing radiance modifiers needed for a model's Walls."""
+
+    type: constr(regex='^WallModifierSetAbridged$') = 'WallModifierSetAbridged'
+
+
+class FloorModifierSetAbridged(BaseModifierSetAbridged):
+    """Abridged set containing radiance modifiers needed for a model's Floors."""
+
+    type: constr(regex='^FloorModifierSetAbridged$') = 'FloorModifierSetAbridged'
+
+
+class RoofCeilingModifierSetAbridged(BaseModifierSetAbridged):
+    """Abridged set containing radiance modifiers needed for a model's Roofs."""
+
+    type: constr(regex='^RoofCeilingModifierSetAbridged$') = \
+        'RoofCeilingModifierSetAbridged'
+
+
+class ShadeModifierSetAbridged(BaseModifierSetAbridged):
+    """Abridged set containing radiance modifiers needed for a model's Shade."""
+
+    type: constr(regex='^ShadeModifierSetAbridged$') = 'ShadeModifierSetAbridged'
+
+
+class ApertureModifierSetAbridged(NoExtraBaseModel):
+    """Abridged set containing radiance modifiers needed for a model's Apertures."""
+
+    type: constr(regex='^ApertureModifierSetAbridged$') = 'ApertureModifierSetAbridged'
+
+    window_modifier: str = Field(
+        default=None,
+        description='Identifier of modifier object for apertures with an Outdoors '
+                    'boundary condition, False is_operable property, '
+                    'and Wall parent Face.'
+    )
+
+    interior_modifier: str = Field(
+        default=None,
+        description='Identifier of modifier object for apertures with a Surface '
+                    'boundary condition.'
+    )
+
+    skylight_modifier: str = Field(
+        default=None,
+        description='Identifier of modifier object for apertures with an Outdoors '
+                    'boundary condition, False is_operable property, and a '
+                    'RoofCeiling or Floor face type for their parent face.'
+    )
+
+    operable_modifier: str = Field(
+        default=None,
+        description='Identifier of modifier object for apertures with an Outdoors '
+                    'boundary condition and a True is_operable property.'
+    )
+
+
+class DoorModifierSetAbridged(BaseModifierSetAbridged):
+    """Abridged set containing radiance modifiers needed for a model's Doors."""
+
+    type: constr(regex='^DoorModifierSetAbridged$') = 'DoorModifierSetAbridged'
+
+    interior_glass_modifier: str = Field(
+        default=None,
+        description='Identifier of modifier object for glass with a Surface '
+                    'boundary condition.'
+    )
+
+    exterior_glass_modifier: str = Field(
+        default=None,
+        description='Identifier of modifier object for glass with an Outdoors '
+                    'boundary condition.'
+    )
+
+    overhead_modifier: str = Field(
+        default=None,
+        description='Identifier of a modifier object for doors with an '
+                    'Outdoors boundary condition and a RoofCeiling or Floor '
+                    'face type for their parent face.'
+    )
+
+
+class ModifierSetAbridged(IDdRadianceBaseModel):
+    """Abridged set containing all modifiers needed to create a radiance model."""
+
+    type: constr(regex='^ModifierSetAbridged$') = 'ModifierSetAbridged'
+
+    wall_set: WallModifierSetAbridged = Field(
+        default=None,
+        description='Optional WallModifierSet object for this '
+                    'ModifierSet (default: None).'
+    )
+
+    floor_set: FloorModifierSetAbridged = Field(
+        default=None,
+        description='Optional FloorModifierSet object for '
+                    'this ModifierSet (default: None).'
+    )
+
+    roof_ceiling_set: RoofCeilingModifierSetAbridged = Field(
+        default=None,
+        description='Optional RoofCeilingModifierSet object for this '
+                    'ModifierSet (default: None).'
+    )
+
+    aperture_set: ApertureModifierSetAbridged = Field(
+        default=None,
+        description='Optional ApertureModifierSet object for this '
+                    'ModifierSet (default: None).'
+    )
+
+    door_set: DoorModifierSetAbridged = Field(
+        default=None,
+        description='Optional DoorModifierSet object for this '
+                    'ModifierSet (default: None).'
+    )
+
+    shade_set: ShadeModifierSetAbridged = Field(
+        default=None,
+        description='Optional ShadeModifierSet object for this '
+                    'ModifierSet (default: None).'
+    )
+
+    air_boundary_modifier: str = Field(
+        default=None,
+        description='Optional Modifier to be used for all Faces '
+                    'with an AirBoundary face type. If None, it will be the '
+                    'honeybee generic air wall modifier.'
+    )
+
+
+class BaseModifierSet(NoExtraBaseModel):
+    """Base class for the modifier sets assigned to Faces."""
+
+    exterior_modifier: _REFERENCE_UNION_MODIFIERS = Field(
+        default=None,
+        description='A radiance modifier object for faces with an Outdoors boundary '
+                    'condition.'
+    )
+
+    interior_modifier: _REFERENCE_UNION_MODIFIERS = Field(
+        default=None,
+        description='A radiance modifier object for faces with a boundary condition '
+                    'other than Outdoors.'
+    )
+
+
+class WallModifierSet(BaseModifierSet):
+    """Set containing radiance modifiers needed for a model's Walls."""
+
+    type: constr(regex='^WallModifierSet$') = 'WallModifierSet'
+
+
+class FloorModifierSet(BaseModifierSet):
+    """Set containing radiance modifiers needed for a model's Floors."""
+
+    type: constr(regex='^FloorModifierSet$') = 'FloorModifierSet'
+
+
+class RoofCeilingModifierSet(BaseModifierSet):
+    """Set containing radiance modifiers needed for a model's roofs."""
+
+    type: constr(regex='^RoofCeilingModifierSet$') = 'RoofCeilingModifierSet'
+
+
+class ShadeModifierSet(BaseModifierSet):
+    """Set containing radiance modifiers needed for a model's Shade."""
+
+    type: constr(regex='^ShadeModifierSet$') = 'ShadeModifierSet'
+
+
+class ApertureModifierSet(NoExtraBaseModel):
+    """Set containing radiance modifiers needed for a model's Apertures."""
+
+    type: constr(regex='^ApertureModifierSet$') = 'ApertureModifierSet'
+
+    window_modifier: _REFERENCE_UNION_MODIFIERS = Field(
+        default=None,
+        description='A modifier object for apertures with an Outdoors '
+                    'boundary condition, False is_operable property, '
+                    'and Wall parent Face.'
+    )
+
+    interior_modifier: _REFERENCE_UNION_MODIFIERS = Field(
+        default=None,
+        description='A modifier object for apertures with a Surface '
+                    'boundary condition.'
+    )
+
+    skylight_modifier: _REFERENCE_UNION_MODIFIERS = Field(
+        default=None,
+        description='A modifier object for apertures with an Outdoors '
+                    'boundary condition, False is_operable property, and a '
+                    'RoofCeiling or Floor face type for their parent face.'
+    )
+
+    operable_modifier: _REFERENCE_UNION_MODIFIERS = Field(
+        default=None,
+        description='A modifier object for apertures with an Outdoors boundary '
+                    'condition and a True is_operable property.'
+    )
+
+
+class DoorModifierSet(BaseModifierSet):
+    """Set containing radiance modifiers needed for a model's Doors."""
+
+    type: constr(regex='^DoorModifierSet$') = 'DoorModifierSet'
+
+    interior_glass_modifier: _REFERENCE_UNION_MODIFIERS = Field(
+        default=None,
+        description='A modifier object for glass with a Surface boundary condition.'
+    )
+
+    exterior_glass_modifier: _REFERENCE_UNION_MODIFIERS = Field(
+        default=None,
+        description='A modifier object for glass with an Outdoors boundary condition.'
+    )
+
+    overhead_modifier: _REFERENCE_UNION_MODIFIERS = Field(
+        default=None,
+        description='A window modifier object for doors with an Outdoors boundary '
+                    'condition and a RoofCeiling or Floor face type for their '
+                    'parent face.'
+    )
+
+
+class ModifierSet(IDdRadianceBaseModel):
+    """Set containing all radiance modifiers needed to create a radiance model."""
+
+    type: constr(regex='^ModifierSet$') = 'ModifierSet'
+
+    wall_set: WallModifierSet = Field(
+        default=None,
+        description='An optional WallModifierSet object for this ModifierSet. '
+                    '(default: None).'
+    )
+
+    floor_set: FloorModifierSet = Field(
+        default=None,
+        description='An optional FloorModifierSet object for this ModifierSet. '
+                    '(default: None).'
+    )
+
+    roof_ceiling_set: RoofCeilingModifierSet = Field(
+        default=None,
+        description='An optional RoofCeilingModifierSet object for this ModifierSet. '
+                    '(default: None).'
+    )
+
+    aperture_set: ApertureModifierSet = Field(
+        default=None,
+        description='An optional ApertureModifierSet object for this ModifierSet. '
+                    '(default: None).'
+    )
+
+    door_set: DoorModifierSet = Field(
+        default=None,
+        description='An optional DoorModifierSet object for this ModifierSet. '
+                    '(default: None).'
+    )
+
+    shade_set: ShadeModifierSet = Field(
+        default=None,
+        description='An optional ShadeModifierSet object for this ModifierSet. '
+                    '(default: None).'
+    )
+
+    air_boundary_modifier: _REFERENCE_UNION_MODIFIERS = Field(
+        default=None,
+        description='An optional Modifier to be used for all Faces with an AirBoundary '
+                    'face type. If None, it will be the honeybee generic air wall '
+                    'modifier.'
+    )

honeybee_schema/radiance/properties.py

@@ -0,0 +1,149 @@
+"""Properties Schema"""
+from pydantic import Field, constr
+from typing import List, Union
+
+from .modifier import _REFERENCE_UNION_MODIFIERS
+from .modifierset import ModifierSet, ModifierSetAbridged
+from .global_modifierset import GlobalModifierSet
+from .asset import SensorGrid, View
+from .._base import NoExtraBaseModel
+
+from honeybee_schema.radiance.state import RadianceShadeStateAbridged, \
+    RadianceSubFaceStateAbridged
+
+
+class _PropertiesBaseAbridged(NoExtraBaseModel):
+    """Base class of Abridged Radiance Properties."""
+
+    modifier: str = Field(
+        default=None,
+        description='A string for a Honeybee Radiance Modifier (default: None).'
+    )
+
+    modifier_blk: str = Field(
+        default=None,
+        description='A string for a Honeybee Radiance Modifier to be used '
+                    'in direct solar simulations and in isolation studies (assessing'
+                    'the contribution of individual objects) (default: None).'
+    )
+
+
+class ShadeMeshRadiancePropertiesAbridged(_PropertiesBaseAbridged):
+    """Radiance Properties for Honeybee ShadeMesh Abridged."""
+
+    type: constr(regex='^ShadeMeshRadiancePropertiesAbridged$') = \
+        'ShadeMeshRadiancePropertiesAbridged'
+
+
+class ApertureRadiancePropertiesAbridged(_PropertiesBaseAbridged):
+    """Radiance Properties for Honeybee Aperture Abridged."""
+
+    type: constr(regex='^ApertureRadiancePropertiesAbridged$') = \
+        'ApertureRadiancePropertiesAbridged'
+
+    dynamic_group_identifier: str = Field(
+        default=None,
+        description="An optional string to note the dynamic group ' \
+            'to which the Aperture is a part of. Apertures sharing the same ' \
+            'dynamic_group_identifier will have their states change in unison. ' \
+            'If None, the Aperture is assumed to be static. (default: None)."
+    )
+
+    states: List[RadianceSubFaceStateAbridged] = Field(
+        default=None,
+        description="An optional list of abridged states (default: None)."
+    )
+
+
+class DoorRadiancePropertiesAbridged(_PropertiesBaseAbridged):
+    """Radiance Properties for Honeybee Door Abridged."""
+
+    type: constr(regex='^DoorRadiancePropertiesAbridged$') = \
+        'DoorRadiancePropertiesAbridged'
+
+    dynamic_group_identifier: str = Field(
+        default=None,
+        description="An optional string to note the dynamic group ' \
+            'to which the Door is a part of. Doors sharing the same ' \
+            'dynamic_group_identifier will have their states change in unison. ' \
+            'If None, the Door is assumed to be static. (default: None)."
+    )
+
+    states: List[RadianceSubFaceStateAbridged] = Field(
+        default=None,
+        description="An optional list of abridged states (default: None)."
+    )
+
+
+class FaceRadiancePropertiesAbridged(_PropertiesBaseAbridged):
+    """Radiance Properties for Honeybee Face Abridged."""
+
+    type: constr(regex='^FaceRadiancePropertiesAbridged$') = \
+        'FaceRadiancePropertiesAbridged'
+
+
+class ShadeRadiancePropertiesAbridged(_PropertiesBaseAbridged):
+    """Radiance Properties for Honeybee Shade Abridged."""
+
+    type: constr(regex='^ShadeRadiancePropertiesAbridged$') = \
+        'ShadeRadiancePropertiesAbridged'
+
+    dynamic_group_identifier: str = Field(
+        default=None,
+        description="An optional string to note the dynamic group ' \
+            'to which the Shade is a part of. Shades sharing the same ' \
+            'dynamic_group_identifier will have their states change in unison. ' \
+            'If None, the Shade is assumed to be static. (default: None)."
+    )
+
+    states: List[RadianceShadeStateAbridged] = Field(
+        default=None,
+        description="An optional list of abridged states (default: None)."
+    )
+
+
+class RoomRadiancePropertiesAbridged(NoExtraBaseModel):
+    """Abridged Radiance Properties for Honeybee Room."""
+
+    type: constr(regex='^RoomRadiancePropertiesAbridged$') = \
+        'RoomRadiancePropertiesAbridged'
+
+    modifier_set: str = Field(
+        default=None,
+        description='An identifier for a unique Room-Assigned ModifierSet '
+                    '(default: None).'
+    )
+
+
+class ModelRadianceProperties(NoExtraBaseModel):
+    """Radiance Properties for Honeybee Model."""
+
+    type: constr(regex='^ModelRadianceProperties$') = 'ModelRadianceProperties'
+
+    global_modifier_set: GlobalModifierSet = Field(
+        default=GlobalModifierSet(),
+        description='Global Radiance modifier set.',
+        readOnly=True
+    )
+
+    modifiers: List[_REFERENCE_UNION_MODIFIERS] = Field(
+        default=None,
+        description='A list of all unique modifiers in the model. '
+                    'This includes modifiers across all Faces, Apertures, Doors, '
+                    'Shades, Room ModifierSets, and the global_modifier_set.'
+    )
+
+    modifier_sets: List[Union[ModifierSet, ModifierSetAbridged]] = Field(
+        default=None,
+        description='A list of all unique Room-Assigned ModifierSets in the Model.'
+    )
+
+    sensor_grids: List[SensorGrid] = Field(
+        default=None,
+        description='An array of SensorGrids that are associated with the model.'
+    )
+
+    views: List[View] = Field(
+        default=None,
+        description='An array of Views that are associated with the model.'
+    )

honeybee_schema/radiance/state.py

@@ -0,0 +1,69 @@
+"""State Schema"""
+from pydantic import Field, constr
+from typing import List
+from .._base import NoExtraBaseModel
+from ._base import IDdRadianceBaseModel
+
+from ..geometry import Face3D
+
+
+class StateGeometryAbridged(IDdRadianceBaseModel):
+    """A single planar geometry that can be assigned to Radiance states."""
+
+    type: constr(regex='^StateGeometryAbridged$') = 'StateGeometryAbridged'
+
+    modifier: str = Field(
+        default=None,
+        description='A string for a Honeybee Radiance Modifier identifier '
+                    '(default: None).'
+    )
+
+    modifier_direct: str = Field(
+        default=None,
+        description='A string for Honeybee Radiance Modifier identifiers to be used '
+                    'in direct solar simulations and in isolation studies (assessing'
+                    'the contribution of individual objects) (default: None).'
+    )
+
+    geometry: Face3D = Field(
+        ...,
+        description='A ladybug_geometry Face3D.'
+    )
+
+
+class RadianceShadeStateAbridged(NoExtraBaseModel):
+    """RadianceShadeStateAbridged represents a single state for a dynamic Shade."""
+
+    type: constr(regex='^RadianceShadeStateAbridged$') = 'RadianceShadeStateAbridged'
+
+    modifier: str = Field(
+        default=None,
+        description='A Radiance Modifier identifier (default: None).'
+    )
+
+    modifier_direct: str = Field(
+        default=None,
+        description='A Radiance Modifier identifier (default: None).'
+    )
+
+    shades: List[StateGeometryAbridged] = Field(
+        default=None,
+        description='A list of StateGeometryAbridged objects (default: None).'
+    )
+
+
+class RadianceSubFaceStateAbridged(RadianceShadeStateAbridged):
+    """RadianceSubFaceStateAbridged is an abridged state for a dynamic Aperture or Door.
+    """
+
+    type: constr(regex='^RadianceSubFaceStateAbridged$') = 'RadianceSubFaceStateAbridged'
+
+    vmtx_geometry: Face3D = Field(
+        default=None,
+        description='A Face3D for the view matrix geometry (default: None).'
+    )
+
+    dmtx_geometry: Face3D = Field(
+        default=None,
+        description='A Face3D for the daylight matrix geometry (default: None).'
+    )

honeybee_schema/updater/version_1_39_12.py

@@ -0,0 +1,14 @@
+"""Changes associated with version Honeybee schema version 1.39.12."""
+
+
+def version_1_39_12(model_dict):
+    """Implement changes in a Model dict to make it compatible with version 1.39.12."""
+    removed_equip = 'PSZ-AC district chilled water with baseboard district hot water'
+    replaced_equip = 'PSZ-AC district chilled water with district hot water'
+    if 'energy' in model_dict['properties']:
+        if 'hvacs' in model_dict['properties']['energy']:
+            for hvac in model_dict['properties']['energy']['hvacs']:
+                if hvac['type'] != 'IdealAirSystemAbridged' and \
+                        hvac['equipment_type'] == removed_equip:
+                    hvac['equipment_type'] = replaced_equip
+    return model_dict