honeybee-schema 1.59.1__py3-none-any.whl

honeybee_schema/energy/daylight.py

@@ -0,0 +1,62 @@
+from pydantic import Field, constr
+from typing import List
+
+from .._base import NoExtraBaseModel
+
+
+class DaylightingControl(NoExtraBaseModel):
+
+    type: constr(regex='^DaylightingControl$') = 'DaylightingControl'
+
+    sensor_position: List[float] = Field(
+        ...,
+        description='A point as 3 (x, y, z) values for the position of the daylight '
+        'sensor within the parent Room. This point should lie within the Room '
+        'volume in order for the results to be meaningful.',
+        min_items=3,
+        max_items=3
+    )
+
+    illuminance_setpoint: float = Field(
+        300,
+        gt=0,
+        description='A number for the illuminance setpoint in lux beyond '
+        'which electric lights are dimmed if there is sufficient daylight.'
+    )
+
+    control_fraction: float = Field(
+        1,
+        ge=0,
+        le=1,
+        description='A number between 0 and 1 that represents the fraction of '
+        'the Room lights that are dimmed when the illuminance at the sensor '
+        'position is at the specified illuminance. 1 indicates that all lights are '
+        'dim-able while 0 indicates that no lights are dim-able. Deeper rooms '
+        'should have lower control fractions to account for the face that the '
+        'lights in the back of the space do not dim in response to suitable '
+        'daylight at the front of the room.'
+    )
+
+    min_power_input: float = Field(
+        0.3,
+        ge=0,
+        le=1,
+        description='A number between 0 and 1 for the the lowest power the '
+        'lighting system can dim down to, expressed as a fraction of maximum '
+        'input power.'
+    )
+
+    min_light_output: float = Field(
+        0.2,
+        ge=0,
+        le=1,
+        description='A number between 0 and 1 the lowest lighting output the '
+        'lighting system can dim down to, expressed as a fraction of maximum '
+        'light output.'
+    )
+
+    off_at_minimum: bool = Field(
+        default=False,
+        description='Boolean to note whether lights should switch off completely '
+        'when they get to the minimum power input.'
+    )

honeybee_schema/energy/designday.py

@@ -0,0 +1,212 @@
+"""Design Day Schema"""
+from pydantic import Field, constr, validator
+from typing import Union, List
+from enum import Enum
+import datetime
+
+from .._base import NoExtraBaseModel
+
+
+class DryBulbCondition(NoExtraBaseModel):
+    """Used to specify dry bulb conditions on a design day."""
+
+    type: constr(regex='^DryBulbCondition$') = 'DryBulbCondition'
+
+    dry_bulb_max: float = Field(
+        ...,
+        ge=-90,
+        le=70,
+        description='The maximum dry bulb temperature on the design day [C].'
+    )
+
+    dry_bulb_range: float = Field(
+        ...,
+        ge=0,
+        description='The difference between min and max temperatures on the '
+        'design day [C].'
+    )
+
+
+class HumidityTypes(str, Enum):
+    wetbulb = 'Wetbulb'
+    dewpoint = 'Dewpoint'
+    humidity_ratio = 'HumidityRatio'
+    enthalpy = 'Enthalpy'
+
+
+class HumidityCondition(NoExtraBaseModel):
+    """Used to specify humidity conditions on a design day."""
+
+    type: constr(regex='^HumidityCondition$') = 'HumidityCondition'
+
+    humidity_type: HumidityTypes
+
+    humidity_value: float = Field(
+        ...,
+        description='The value correcponding to the humidity_type.'
+    )
+
+    barometric_pressure: float = Field(
+        101325,
+        ge=31000,
+        le=120000,
+        description='Barometric air pressure on the design day [Pa].'
+    )
+
+    rain: bool = Field(
+        default=False,
+        description='Boolean to indicate rain on the design day.'
+    )
+
+    snow_on_ground: bool = Field(
+        default=False,
+        description='Boolean to indicate snow on the ground during the design day.'
+    )
+
+
+class WindCondition(NoExtraBaseModel):
+    """Used to specify wind conditions on a design day."""
+
+    type: constr(regex='^WindCondition$') = 'WindCondition'
+
+    wind_speed: float = Field(
+        ...,
+        ge=0,
+        le=40,
+        description='Wind speed on the design day [m/s].'
+    )
+
+    wind_direction: float = Field(
+        0,
+        ge=0,
+        le=360,
+        description='Wind direction on the design day [degrees].'
+    )
+
+
+class _SkyCondition(NoExtraBaseModel):
+    """Used to specify sky conditions on a design day."""
+
+    date: List[int] = Field(
+        ...,
+        min_items=2,
+        max_items=3,
+        description='A list of two integers for [month, day], representing the date '
+        'for the day of the year on which the design day occurs. '
+        'A third integer may be added to denote whether the date should be '
+        're-serialized for a leap year (it should be a 1 in this case).'
+    )
+
+    @validator('date')
+    def check_date(cls, v):
+        "Ensure valid date."
+        if len(v) == 3 and v[2]:
+            try:
+                datetime.date(2016, v[0], v[1])
+            except ValueError:
+                raise ValueError('{}/{} is not a valid date.'.format(v[0], v[1]))
+        else:
+            try:
+                datetime.date(2017, v[0], v[1])
+            except ValueError:
+                raise ValueError('{}/{} is not a valid date.'.format(v[0], v[1]))
+        return v
+
+    daylight_savings: bool = Field(
+        default=False,
+        description='Boolean to indicate whether daylight savings time is active '
+        'on the design day.'
+    )
+
+
+class ASHRAEClearSky(_SkyCondition):
+    """Used to specify sky conditions on a design day."""
+
+    type: constr(regex='^ASHRAEClearSky$') = 'ASHRAEClearSky'
+
+    clearness: float = Field(
+        ...,
+        ge=0,
+        le=1.2,
+        description='Value between 0 and 1.2 that will get multiplied by the '
+        'irradiance to correct for factors like elevation above sea level.'
+    )
+
+
+class ASHRAETau(_SkyCondition):
+    """Used to specify sky conditions on a design day."""
+
+    type: constr(regex='^ASHRAETau$') = 'ASHRAETau'
+
+    tau_b: float = Field(
+        ...,
+        ge=0,
+        le=1.2,
+        description='Value for the beam optical depth. Typically found in .stat files.'
+    )
+
+    tau_d: float = Field(
+        ...,
+        ge=0,
+        le=3,
+        description='Value for the diffuse optical depth. Typically found in .stat files.'
+    )
+
+
+class DesignDayTypes(str, Enum):
+    summer_design_day = 'SummerDesignDay'
+    winter_design_day = 'WinterDesignDay'
+    sunday = 'Sunday'
+    monday = 'Monday'
+    tuesday = 'Tuesday'
+    wednesday = 'Wednesday'
+    thursday = 'Thursday'
+    friday = 'Friday'
+    holiday = 'Holiday'
+    custom_day1 = 'CustomDay1'
+    custom_day2 = 'CustomDay2'
+
+
+class DesignDay(NoExtraBaseModel):
+    """An object representing design day conditions."""
+
+    type: constr(regex='^DesignDay$') = 'DesignDay'
+
+    name: str = Field(
+        ...,
+        min_length=1,
+        max_length=100,
+        description='Text string for a unique design day name. This name remains '
+        'constant as the object is mutated, copied, and serialized to different '
+        'formats (eg. dict, idf, osm). It is also used to reference the object '
+        'within SimulationParameters. It must be < 100 characters, use only '
+        'ASCII characters and exclude (, ; ! \\n \\t).'
+    )
+
+    @validator('name')
+    def check_identifier(cls, v):
+        assert all(ord(i) < 128 for i in v), 'Name contains non ASCII characters.'
+        assert all(char not in v for char in (',', ';', '!', '\n', '\t')), \
+            'Name contains an invalid character for EnergyPlus (, ; ! \\n \\t).'
+        return v
+
+    day_type: DesignDayTypes
+
+    dry_bulb_condition: DryBulbCondition = Field(
+        ...,
+        description='A DryBulbCondition describing temperature conditions on '
+        'the design day.'
+    )
+
+    humidity_condition: HumidityCondition = Field(
+        ...,
+        description='A HumidityCondition describing humidity and precipitation '
+        'conditions on the design day.'
+    )
+
+    wind_condition: WindCondition = Field(
+        ...,
+        description='A WindCondition describing wind conditions on the design day.'
+    )
+
+    sky_condition: Union[ASHRAEClearSky, ASHRAETau]

honeybee_schema/energy/generator.py

@@ -0,0 +1,140 @@
+"""Schemas for objects that generate electricity."""
+from pydantic import Field, constr
+
+from .._base import NoExtraBaseModel
+from ._base import EnergyBaseModel
+from enum import Enum
+
+
+class ElectricLoadCenter(NoExtraBaseModel):
+
+    type: constr(regex='^ElectricLoadCenter$') = 'ElectricLoadCenter'
+
+    inverter_efficiency: float = Field(
+        0.96,
+        gt=0,
+        le=1,
+        description='A number between 0 and 1 for the load center inverter nominal '
+        'rated DC-to-AC conversion efficiency. An inverter converts DC power, such '
+        'as that output by photovoltaic panels, to AC power, such as that distributed '
+        'by the electrical grid and is available from standard electrical outlets. '
+        'Inverter efficiency is defined as the inverter rated AC power output divided '
+        'by its rated DC power output.'
+    )
+
+    inverter_dc_to_ac_size_ratio: float = Field(
+        1.1,
+        gt=0,
+        description='A positive number (typically greater than 1) for the ratio of '
+        'the inverter DC rated size to its AC rated size. Typically, inverters are '
+        'not sized to convert the full DC output under standard test conditions (STC) '
+        'as such conditions rarely occur in reality and therefore unnecessarily add '
+        'to the size/cost of the inverter. For a system with a high DC to AC size '
+        'ratio, during times when the DC power output exceeds the inverter rated '
+        'DC input size, the inverter limits the power output by increasing the '
+        'DC operating voltage, which moves the arrays operating point down its '
+        'current-voltage (I-V) curve. In EnergyPlus, this is accomplished by simply '
+        'limiting the system output to the AC size as dictated by the ratio. The '
+        'default value of 1.1 is reasonable for most systems. A typical range is '
+        '1.1 to 1.25, although some large-scale systems have ratios of as high '
+        'as 1.5. The optimal value depends on the system location, array '
+        'orientation, and module cost.'
+    )
+
+
+class ModuleType(str, Enum):
+    standard = 'Standard'
+    premium = 'Premium'
+    thin_film = 'ThinFilm'
+
+
+class MountingType(str, Enum):
+    fixed_open_rack = 'FixedOpenRack'
+    fixed_roof_mounted = 'FixedRoofMounted'
+    one_axis = 'OneAxis'
+    one_axis_backtracking = 'OneAxisBacktracking'
+    two_axis = 'TwoAxis'
+
+
+class PVProperties(EnergyBaseModel):
+
+    type: constr(regex='^PVProperties$') = 'PVProperties'
+
+    rated_efficiency: float = Field(
+        0.15,
+        gt=0,
+        lt=1,
+        description='A number between 0 and 1 for the rated nameplate efficiency '
+        'of the photovoltaic solar cells under standard test conditions (STC). '
+        'Standard test conditions are 1,000 Watts per square meter solar '
+        'irradiance, 25 degrees C cell temperature, and ASTM G173-03 standard '
+        'spectrum. Nameplate efficiencies reported by manufacturers are typically '
+        'under STC. Standard poly- or mono-crystalline silicon modules tend to have '
+        'rated efficiencies in the range of 14-17%. Premium high efficiency '
+        'mono-crystalline silicon modules with anti-reflective coatings can have '
+        'efficiencies in the range of 18-20%. Thin film photovoltaic modules '
+        'typically have efficiencies of 11% or less. (Default: 0.15 for standard '
+        'silicon solar cells).'
+    )
+
+    active_area_fraction: float = Field(
+        0.9,
+        gt=0,
+        le=1,
+        description='The fraction of the parent Shade geometry that is '
+        'covered in active solar cells. This fraction includes the difference '
+        'between the PV panel (aka. PV module) area and the active cells within '
+        'the panel as well as any losses for how the (typically rectangular) panels '
+        'can be arranged on the Shade geometry. When the parent Shade geometry '
+        'represents just the solar panels, this fraction is typically around 0.9 '
+        'given that the framing elements of the panel reduce the overall '
+        'active area. (Default: 0.9, assuming parent Shade geometry represents '
+        'only the PV panel geometry).'
+    )
+
+    module_type: ModuleType = Field(
+        default=ModuleType.standard,
+        description='Text to indicate the type of solar module. This is used to '
+        'determine the temperature coefficients used in the simulation of the '
+        'photovoltaic modules. When the rated_efficiency is between 12-18%, the '
+        'Standard type is typically most appropriate. When the rated_efficiency is '
+        'greater than 18%, the Premium type is likely more appropriate. When '
+        'the rated_efficiency is less than 12%, this likely refers to a case where '
+        'the ThinFilm module type is most appropriate.'
+    )
+
+    mounting_type: MountingType = Field(
+        default=MountingType.fixed_open_rack,
+        description='Text to indicate the type of mounting and/or tracking used '
+        'for the photovoltaic array. Note that the OneAxis options have an axis '
+        'of rotation that is determined by the azimuth of the parent Shade '
+        'geometry. Also note that, in the case of one or two axis tracking, '
+        'shadows on the (static) parent Shade geometry still reduce the '
+        'electrical output, enabling the simulation to account for large '
+        'context geometry casting shadows on the array. However, the effects '
+        'of smaller detailed shading may be improperly accounted for and self '
+        'shading of the dynamic panel geometry is only accounted for via the '
+        'tracking_ground_coverage_ratio property on this object. FixedOpenRack '
+        'refers to ground or roof mounting where the air flows freely. FixedRoofMounted '
+        'refers to mounting flush with the roof with limited air flow. OneAxis '
+        'refers to a fixed tilt and azimuth, which define an axis of rotation. '
+        'OneAxisBacktracking is the same as OneAxis but with controls to reduce '
+        'self-shade at low sun angles. TwoAxis refers to a dynamic tilt and '
+        'azimuth that track the sun.'
+    )
+
+    system_loss_fraction: float = Field(
+        0.14,
+        ge=0,
+        le=1,
+        description='A number between 0 and 1 for the fraction of the electricity '
+        'output lost due to factors other than EPW weather conditions, '
+        'panel efficiency/type, active area, mounting, and inverter conversion from '
+        'DC to AC. Factors that should be accounted for in this input include '
+        'soiling, snow, wiring losses, electrical connection losses, manufacturer '
+        'defects/tolerances/mismatch in cell characteristics, losses from power '
+        'grid availability, and losses due to age or light-induced degradation. '
+        'Losses from these factors tend to be between 10-20% but can vary widely '
+        'depending on the installation, maintenance and the grid to which the '
+        'panels are connected..'
+    )

honeybee_schema/energy/global_constructionset.py

@@ -0,0 +1,129 @@
+"""Global construction-set for Model."""
+import pathlib
+import json
+
+from typing import List, Union
+from pydantic import constr, Field
+
+from honeybee_standards import energy_default
+
+from .._base import NoExtraBaseModel
+from .constructionset import WallConstructionSetAbridged, FloorConstructionSetAbridged, \
+    RoofCeilingConstructionSetAbridged, ApertureConstructionSetAbridged, \
+    DoorConstructionSetAbridged
+from .construction import OpaqueConstructionAbridged, WindowConstructionAbridged, \
+    ShadeConstruction, AirBoundaryConstructionAbridged
+from .material import EnergyMaterial, EnergyMaterialNoMass, \
+    EnergyWindowMaterialGlazing, EnergyWindowMaterialGas
+
+
+# import constructionset default values from honeybee standards
+_DEFAULTS = json.loads(pathlib.Path(energy_default).read_text())
+_CSET = [
+    ms for ms in _DEFAULTS['construction_sets']
+    if ms['identifier'] == 'Default Generic Construction Set'][0]
+_CONSTRUCTION_NAMES = [
+    'Generic Exterior Wall', 'Generic Interior Wall', 'Generic Underground Wall',
+    'Generic Exposed Floor', 'Generic Interior Floor', 'Generic Ground Slab',
+    'Generic Roof', 'Generic Interior Ceiling', 'Generic Underground Roof',
+    'Generic Double Pane', 'Generic Single Pane', 'Generic Exterior Door',
+    'Generic Interior Door', 'Generic Shade', 'Generic Context', 'Generic Air Boundary'
+]
+_CONSTRUCTIONS = [
+    OpaqueConstructionAbridged.parse_obj(m)
+    if m['type'] == 'OpaqueConstructionAbridged'
+    else WindowConstructionAbridged.parse_obj(m)
+    if m['type'] == 'WindowConstructionAbridged'
+    else ShadeConstruction.parse_obj(m)
+    if m['type'] == 'ShadeConstruction'
+    else AirBoundaryConstructionAbridged.parse_obj(m)
+    for m in _DEFAULTS['constructions'] if m['identifier'] in _CONSTRUCTION_NAMES
+]
+_MATERIAL_NAMES = [
+    'Generic 25mm Wood', 'Generic Clear Glass', 'Generic LW Concrete',
+    'Generic Ceiling Air Gap', 'Generic Acoustic Tile', 'Generic Gypsum Board',
+    'Generic Wall Air Gap', 'Generic Painted Metal', 'Generic 50mm Insulation',
+    'Generic Roof Membrane', 'Generic Brick', 'Generic HW Concrete',
+    'Generic Low-e Glass', 'Generic Window Air Gap', 'Generic 25mm Insulation'
+]
+_MATERIALS = [
+    EnergyMaterial.parse_obj(m)
+    if m['type'] == 'EnergyMaterial'
+    else EnergyMaterialNoMass.parse_obj(m)
+    if m['type'] == 'EnergyMaterialNoMass'
+    else EnergyWindowMaterialGlazing.parse_obj(m)
+    if m['type'] == 'EnergyWindowMaterialGlazing'
+    else EnergyWindowMaterialGas.parse_obj(m)
+    for m in _DEFAULTS['materials'] if m['identifier'] in _MATERIAL_NAMES
+]
+
+
+class GlobalConstructionSet(NoExtraBaseModel):
+
+    type: constr(regex='^GlobalConstructionSet$') = 'GlobalConstructionSet'
+
+    materials: List[Union[
+        EnergyMaterial, EnergyMaterialNoMass,
+        EnergyWindowMaterialGlazing, EnergyWindowMaterialGas
+    ]] = Field(
+        default=_MATERIALS,
+        description='Global Honeybee Energy materials.',
+        readOnly=True
+    )
+
+    constructions: List[Union[
+        OpaqueConstructionAbridged, WindowConstructionAbridged,
+        ShadeConstruction, AirBoundaryConstructionAbridged
+    ]] = Field(
+        default=_CONSTRUCTIONS,
+        description='Global Honeybee Energy constructions.',
+        readOnly=True
+    )
+
+    wall_set: WallConstructionSetAbridged = Field(
+        default=WallConstructionSetAbridged.parse_obj(_CSET['wall_set']),
+        description='Global Honeybee WallConstructionSet.',
+        readOnly=True
+    )
+
+    floor_set: FloorConstructionSetAbridged = Field(
+        default=FloorConstructionSetAbridged.parse_obj(_CSET['floor_set']),
+        description='Global Honeybee FloorConstructionSet.',
+        readOnly=True
+    )
+
+    roof_ceiling_set: RoofCeilingConstructionSetAbridged = Field(
+        default=RoofCeilingConstructionSetAbridged.parse_obj(_CSET['roof_ceiling_set']),
+        description='Global Honeybee RoofCeilingConstructionSet.',
+        readOnly=True
+    )
+
+    aperture_set: ApertureConstructionSetAbridged = Field(
+        default=ApertureConstructionSetAbridged.parse_obj(_CSET['aperture_set']),
+        description='Global Honeybee ApertureConstructionSet.',
+        readOnly=True
+    )
+
+    door_set: DoorConstructionSetAbridged = Field(
+        default=DoorConstructionSetAbridged.parse_obj(_CSET['door_set']),
+        description='Global Honeybee DoorConstructionSet.',
+        readOnly=True
+    )
+
+    shade_construction: str = Field(
+        default=_CSET['shade_construction'],
+        description='Global Honeybee Construction for building-attached Shades.',
+        readOnly=True
+    )
+
+    context_construction: str = Field(
+        default='Generic Context',
+        description='Global Honeybee Construction for context Shades.',
+        readOnly=True
+    )
+
+    air_boundary_construction: str = Field(
+        default=_CSET['air_boundary_construction'],
+        description='Global Honeybee Construction for AirBoundary Faces.',
+        readOnly=True
+    )

honeybee_schema/energy/hvac/_template.py

@@ -0,0 +1,38 @@
+"""Base class for HVAC systems following a standards template."""
+from pydantic import Field
+from enum import Enum
+
+from .._base import IDdEnergyBaseModel
+
+
+class Vintages(str, Enum):
+    ashrae_2019 = 'ASHRAE_2019'
+    ashrae_2016 = 'ASHRAE_2016'
+    ashrae_2013 = 'ASHRAE_2013'
+    ashrae_2010 = 'ASHRAE_2010'
+    ashrae_2007 = 'ASHRAE_2007'
+    ashrae_2004 = 'ASHRAE_2004'
+    doe_ref_1980_2004 = 'DOE_Ref_1980_2004'
+    doe_ref_pre_1980 = 'DOE_Ref_Pre_1980'
+
+
+class _TemplateSystem(IDdEnergyBaseModel):
+    """Base class for HVAC systems following a standards template."""
+
+    vintage: Vintages = Field(
+        Vintages.ashrae_2019,
+        description='Text for the vintage of the template system. This will be used '
+        'to set efficiencies for various pieces of equipment within the system. '
+        'Further information about these defaults can be found in the version of '
+        'ASHRAE 90.1 corresponding to the selected vintage. Read-only versions '
+        'of the standard can be found at: https://www.ashrae.org/technical-resources/'
+        'standards-and-guidelines/read-only-versions-of-ashrae-standards'
+    )
+
+
+class RadiantFaceTypes(str, Enum):
+    floor = 'Floor'
+    ceiling = 'Ceiling'
+    floor_with_carpet = 'FloorWithCarpet'
+    ceiling_metal_panel = 'CeilingMetalPanel'
+    floor_with_hardwood = 'FloorWithHardwood'