honeybee-energy 1.116.106__py3-none-any.whl

honeybee_energy/hvac/heatcool/_base.py

@@ -0,0 +1,177 @@
+# coding=utf-8
+"""Base class for all heating/cooling systems without any ventilation."""
+from __future__ import division
+import os
+
+from honeybee._lockable import lockable
+
+from .._template import _TemplateSystem, _EnumerationBase
+from ..idealair import IdealAirSystem
+from ...properties.extension import HeatCoolSystemProperties
+
+
+@lockable
+class _HeatCoolBase(_TemplateSystem):
+    """Base class for all heating/cooling systems without any ventilation.
+
+    Args:
+        identifier: Text string for system identifier. Must be < 100 characters
+            and not contain any EnergyPlus special characters. This will be used to
+            identify the object across a model and in the exported IDF.
+        vintage: Text for the vintage of the template system. This will be used
+            to set efficiencies for various pieces of equipment within the system.
+            Choose from the following.
+
+            * DOE_Ref_Pre_1980
+            * DOE_Ref_1980_2004
+            * ASHRAE_2004
+            * ASHRAE_2007
+            * ASHRAE_2010
+            * ASHRAE_2013
+            * ASHRAE_2016
+            * ASHRAE_2019
+
+        equipment_type: Text for the specific type of the system and equipment.
+            For example, 'Baseboard gas boiler'.
+
+    Properties:
+        * identifier
+        * display_name
+        * vintage
+        * equipment_type
+        * has_district_heating
+        * has_district_cooling
+        * user_data
+        * properties
+    """
+    __slots__ = ('_properties',)
+    COOL_ONLY_TYPES = (
+        'EvapCoolers', 'FCU_Chiller', 'FCU_ACChiller', 'FCU_DCW',
+        'ResidentialAC', 'WindowAC'
+    )
+    HEAT_ONLY_TYPES = (
+        'ElectricBaseboard', 'BoilerBaseboard', 'ASHPBaseboard',
+        'DHWBaseboard', 'GasHeaters', 'ResidentialHPNoCool', 'ResidentialFurnace'
+    )
+
+    def __init__(self, identifier, vintage='ASHRAE_2019', equipment_type=None):
+        # initialize base HVAC system properties
+        _TemplateSystem.__init__(self, identifier, vintage, equipment_type)
+        self._properties = HeatCoolSystemProperties(self)
+
+    def to_ideal_air_equivalent(self):
+        """Get a version of this HVAC as an IdealAirSystem."""
+        i_sys = IdealAirSystem(self.identifier)
+        if self.equipment_type in self.COOL_ONLY_TYPES:
+            i_sys.heating_limit = 0
+        if self.equipment_type in self.HEAT_ONLY_TYPES:
+            i_sys.cooling_limit = 0
+        i_sys.economizer_type = 'NoEconomizer'
+        i_sys._display_name = self._display_name
+        return i_sys
+
+    @property
+    def properties(self):
+        """Get properties for extensions."""
+        return self._properties
+
+    @classmethod
+    def from_dict(cls, data):
+        """Create a HVAC object from a dictionary.
+
+        Args:
+            data: A HeatCool dictionary in following the format below.
+
+        .. code-block:: python
+
+            {
+            "type": "",  # text for the class name of the HVAC
+            "identifier": "Classroom1_System",  # identifier for the HVAC
+            "display_name": "Standard System",  # name for the HVAC
+            "vintage": "ASHRAE_2019",  # text for the vintage of the template
+            "equipment_type": "",  # text for the HVAC equipment type
+            "properties": { ... } # HeatCoolSystemProperties as a dict
+            }
+        """
+        assert data['type'] == cls.__name__, \
+            'Expected {} dictionary. Got {}.'.format(cls.__name__, data['type'])
+        new_obj = cls(data['identifier'], data['vintage'], data['equipment_type'])
+        if 'display_name' in data and data['display_name'] is not None:
+            new_obj.display_name = data['display_name']
+        if 'user_data' in data and data['user_data'] is not None:
+            new_obj.user_data = data['user_data']
+        if 'properties' in data and data['properties'] is not None:
+            new_obj.properties._load_extension_attr_from_dict(data['properties'])
+        return new_obj
+
+    @classmethod
+    def from_dict_abridged(cls, data, schedule_dict):
+        """Create a HVAC object from an abridged dictionary.
+
+        Args:
+            data: A HeatCool abridged dictionary in following the format below.
+            schedule_dict: A dictionary with schedule identifiers as keys and honeybee
+                schedule objects as values (either ScheduleRuleset or
+                ScheduleFixedInterval). These will be used to assign the schedules
+                to the Setpoint object.
+
+        .. code-block:: python
+
+            {
+            "type": "",  # text for the class name of the HVAC
+            "identifier": "Classroom1_System",  # identifier for the HVAC
+            "display_name": "Standard System",  # name for the HVAC
+            "vintage": "ASHRAE_2019",  # text for the vintage of the template
+            "equipment_type": "",  # text for the HVAC equipment type
+            "properties": { ... } # dict of the HeatCoolSystemProperties
+            }
+        """
+        # this is the same as the from_dict method for as long as there are not schedules
+        return cls.from_dict(data)
+
+    def to_dict(self, abridged=False):
+        """HeatCool system dictionary representation.
+
+        Args:
+            abridged: Boolean to note whether the full dictionary describing the
+                object should be returned (False) or just an abridged version (True).
+                This input currently has no effect but may eventually have one if
+                schedule-type properties are exposed on this template.
+        """
+
+        """Get a base dictionary of the HeatCool system."""
+        base = {'type': self.__class__.__name__}
+        base['identifier'] = self.identifier
+        if self._display_name is not None:
+            base['display_name'] = self.display_name
+        base['vintage'] = self.vintage
+        base['equipment_type'] = self.equipment_type
+        if self._user_data is not None:
+            base['user_data'] = self.user_data
+        prop_dict = self.properties.to_dict()
+        if prop_dict is not None:
+            base['properties'] = prop_dict
+        return base
+
+    def __copy__(self):
+        new_obj = self.__class__(self._identifier, self.vintage, self._equipment_type)
+        new_obj._display_name = self._display_name
+        new_obj._user_data = None if self._user_data is None else self._user_data.copy()
+        new_obj._properties._duplicate_extension_attr(self._properties)
+        return new_obj
+
+
+class _HeatCoolEnumeration(_EnumerationBase):
+    """Enumerates the systems that inherit from _HeatCoolBase."""
+
+    def __init__(self, import_modules=True):
+        if import_modules:
+            self._import_modules(
+                os.path.dirname(__file__), 'honeybee_energy.hvac.heatcool')
+
+        self._HVAC_TYPES = {}
+        self._EQUIPMENT_TYPES = {}
+        for clss in _HeatCoolBase.__subclasses__():
+            self._HVAC_TYPES[clss.__name__] = clss
+            for equip_type in clss.EQUIPMENT_TYPES:
+                self._EQUIPMENT_TYPES[equip_type] = clss

honeybee_energy/hvac/heatcool/baseboard.py

@@ -0,0 +1,61 @@
+# coding=utf-8
+"""Baseboard heating system. Intended for spaces only requiring heating."""
+from __future__ import division
+
+from ._base import _HeatCoolBase
+
+from honeybee._lockable import lockable
+
+
+@lockable
+class Baseboard(_HeatCoolBase):
+    """Baseboard heating system.
+
+    Baseboard systems are intended for spaces only requiring heating and
+    no ventilation or cooling. Each room/zone will get its own baseboard
+    heating unit that satisfies the heating load.
+
+    Args:
+        identifier: Text string for system identifier. Must be < 100 characters
+            and not contain any EnergyPlus special characters. This will be used to
+            identify the object across a model and in the exported IDF.
+        vintage: Text for the vintage of the template system. This will be used
+            to set efficiencies for various pieces of equipment within the system.
+            Choose from the following.
+
+            * DOE_Ref_Pre_1980
+            * DOE_Ref_1980_2004
+            * ASHRAE_2004
+            * ASHRAE_2007
+            * ASHRAE_2010
+            * ASHRAE_2013
+            * ASHRAE_2016
+            * ASHRAE_2019
+
+        equipment_type: Text for the specific type of the system and equipment. (Default:
+            the first option below) Choose from.
+
+            * ElectricBaseboard
+            * BoilerBaseboard
+            * ASHPBaseboard
+            * DHWBaseboard
+
+    Properties:
+        * identifier
+        * display_name
+        * vintage
+        * equipment_type
+        * schedules
+        * has_district_heating
+        * has_district_cooling
+        * user_data
+        * properties
+    """
+    __slots__ = ()
+
+    EQUIPMENT_TYPES = (
+        'ElectricBaseboard',
+        'BoilerBaseboard',
+        'ASHPBaseboard',
+        'DHWBaseboard'
+    )

honeybee_energy/hvac/heatcool/evapcool.py

@@ -0,0 +1,72 @@
+# coding=utf-8
+"""Direct evaporative cooling systems (with optional heating)."""
+from __future__ import division
+
+from ._base import _HeatCoolBase
+
+from honeybee._lockable import lockable
+
+
+@lockable
+class EvaporativeCooler(_HeatCoolBase):
+    """Direct evaporative cooling systems (with optional heating).
+
+    Each room/zone will receive its own air loop sized to meet the sensible load,
+    which contains an evaporative cooler that directly adds humidity to the room
+    air to cool it. The loop contains an outdoor air mixer, which is used whenever
+    the outdoor air has a lower wet bulb temperature than the return air from
+    the room. In the event that the combination of outdoor and room return air
+    air is too humid, a backup single-speed direct expansion (DX) cooling coil
+    will be used. Heating loads can be met with various options, including
+    several types of baseboards, a furnace, or gas unit heaters.
+
+    Args:
+        identifier: Text string for system identifier. Must be < 100 characters
+            and not contain any EnergyPlus special characters. This will be used to
+            identify the object across a model and in the exported IDF.
+        vintage: Text for the vintage of the template system. This will be used
+            to set efficiencies for various pieces of equipment within the system.
+            Choose from the following.
+
+            * DOE_Ref_Pre_1980
+            * DOE_Ref_1980_2004
+            * ASHRAE_2004
+            * ASHRAE_2007
+            * ASHRAE_2010
+            * ASHRAE_2013
+            * ASHRAE_2016
+            * ASHRAE_2019
+
+        equipment_type: Text for the specific type of the system and equipment. (Default:
+            the first option below) Choose from.
+
+            * EvapCoolers_ElectricBaseboard
+            * EvapCoolers_BoilerBaseboard
+            * EvapCoolers_ASHPBaseboard
+            * EvapCoolers_DHWBaseboard
+            * EvapCoolers_Furnace
+            * EvapCoolers_UnitHeaters
+            * EvapCoolers
+
+    Properties:
+        * identifier
+        * display_name
+        * vintage
+        * equipment_type
+        * schedules
+        * has_district_heating
+        * has_district_cooling
+        * user_data
+        * properties
+    """
+    __slots__ = ()
+
+    EQUIPMENT_TYPES = (
+        'EvapCoolers_ElectricBaseboard',
+        'EvapCoolers_BoilerBaseboard',
+        'EvapCoolers_ASHPBaseboard',
+        'EvapCoolers_DHWBaseboard',
+        'EvapCoolers_Furnace',
+        'EvapCoolers_UnitHeaters',
+        'EvapCoolers'
+    )

honeybee_energy/hvac/heatcool/fcu.py

@@ -0,0 +1,92 @@
+# coding=utf-8
+"""Fan Coil Unit (FCU) heating/cooling system (with no ventilation)."""
+from __future__ import division
+
+from ._base import _HeatCoolBase
+
+from honeybee._lockable import lockable
+
+
+@lockable
+class FCU(_HeatCoolBase):
+    """Fan Coil Unit (FCU) heating/cooling system (with no ventilation).
+
+    Each room/zone receives its own Fan Coil Unit (FCU), which meets the heating
+    and cooling loads of the space. The cooling coil in the FCU is always chilled
+    water cooling coil, which is connected to a chilled water loop operating
+    at 6.7C (44F). The heating coil is a hot water coil except when when electric
+    baseboards or gas heaters are specified. Hot water temperature is 82C (180F) for
+    boiler/district heating and 49C (120F) when ASHP is used.
+
+    Args:
+        identifier: Text string for system identifier. Must be < 100 characters
+            and not contain any EnergyPlus special characters. This will be used to
+            identify the object across a model and in the exported IDF.
+        vintage: Text for the vintage of the template system. This will be used
+            to set efficiencies for various pieces of equipment within the system.
+            Choose from the following.
+
+            * DOE_Ref_Pre_1980
+            * DOE_Ref_1980_2004
+            * ASHRAE_2004
+            * ASHRAE_2007
+            * ASHRAE_2010
+            * ASHRAE_2013
+            * ASHRAE_2016
+            * ASHRAE_2019
+
+        equipment_type: Text for the specific type of the system and equipment. (Default:
+            the first option below) Choose from.
+
+            * FCU_Chiller_Boiler
+            * FCU_Chiller_ASHP
+            * FCU_Chiller_DHW
+            * FCU_Chiller_ElectricBaseboard
+            * FCU_Chiller_GasHeaters
+            * FCU_Chiller
+            * FCU_ACChiller_Boiler
+            * FCU_ACChiller_ASHP
+            * FCU_ACChiller_DHW
+            * FCU_ACChiller_ElectricBaseboard
+            * FCU_ACChiller_GasHeaters
+            * FCU_ACChiller
+            * FCU_DCW_Boiler
+            * FCU_DCW_ASHP
+            * FCU_DCW_DHW
+            * FCU_DCW_ElectricBaseboard
+            * FCU_DCW_GasHeaters
+            * FCU_DCW
+
+    Properties:
+        * identifier
+        * display_name
+        * vintage
+        * equipment_type
+        * schedules
+        * has_district_heating
+        * has_district_cooling
+        * user_data
+        * properties
+    """
+    __slots__ = ()
+
+    EQUIPMENT_TYPES = (
+        'FCU_Chiller_Boiler',
+        'FCU_Chiller_ASHP',
+        'FCU_Chiller_DHW',
+        'FCU_Chiller_ElectricBaseboard',
+        'FCU_Chiller_GasHeaters',
+        'FCU_Chiller',
+        'FCU_ACChiller_Boiler',
+        'FCU_ACChiller_ASHP',
+        'FCU_ACChiller_DHW',
+        'FCU_ACChiller_ElectricBaseboard',
+        'FCU_ACChiller_GasHeaters',
+        'FCU_ACChiller',
+        'FCU_DCW_Boiler',
+        'FCU_DCW_ASHP',
+        'FCU_DCW_DHW',
+        'FCU_DCW_ElectricBaseboard',
+        'FCU_DCW_GasHeaters',
+        'FCU_DCW'
+    )

honeybee_energy/hvac/heatcool/gasunit.py

@@ -0,0 +1,53 @@
+# coding=utf-8
+"""Gas unit heating system. Intended for spaces only requiring heating."""
+from __future__ import division
+
+from ._base import _HeatCoolBase
+
+from honeybee._lockable import lockable
+
+
+@lockable
+class GasUnitHeater(_HeatCoolBase):
+    """Gas unit heating system.
+
+    Gas unit systems are intended for spaces only requiring heating and no
+    ventilation or cooling. Each room/zone will get its own gaa heating unit
+    that satisfies the heating load.
+
+    Args:
+        identifier: Text string for system identifier. Must be < 100 characters
+            and not contain any EnergyPlus special characters. This will be used to
+            identify the object across a model and in the exported IDF.
+        vintage: Text for the vintage of the template system. This will be used
+            to set efficiencies for various pieces of equipment within the system.
+            Choose from the following.
+
+            * DOE_Ref_Pre_1980
+            * DOE_Ref_1980_2004
+            * ASHRAE_2004
+            * ASHRAE_2007
+            * ASHRAE_2010
+            * ASHRAE_2013
+            * ASHRAE_2016
+            * ASHRAE_2019
+
+        equipment_type: Text for the specific type of the system and equipment. (Default:
+            the first option below) Choose from.
+
+            * GasHeaters
+
+    Properties:
+        * identifier
+        * display_name
+        * vintage
+        * equipment_type
+        * schedules
+        * has_district_heating
+        * has_district_cooling
+        * user_data
+        * properties
+    """
+    __slots__ = ()
+
+    EQUIPMENT_TYPES = ('GasHeaters',)