honeybee_energy.hvac.allair.ptac module

Packaged Terminal Air Conditioning (PTAC) or Heat Pump (PTHP) HVAC system.

class honeybee_energy.hvac.allair.ptac.PTAC(identifier, vintage='ASHRAE_2019', equipment_type=None)[source]

Bases: _AllAirBase

Packaged Terminal Air Conditioning (PTAC/HP) HVAC system. (aka. System 1 or 2).

Each room/zone receives its own packaged unit that supplies heating, cooling and ventilation. Cooling is always done via a single-speed direct expansion (DX) cooling coil. Heating can be done via a heating coil in the unit or via an external baseboard. Fans are constant volume.

PTAC/HP systems are the traditional baseline system for residential buildings.

Parameters:

  • 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.

    • PTAC_ElectricBaseboard

    • PTAC_BoilerBaseboard

    • PTAC_DHWBaseboard

    • PTAC_GasHeaters

    • PTAC_ElectricCoil

    • PTAC_GasCoil

    • PTAC_Boiler

    • PTAC_ASHP

    • PTAC_DHW

    • PTAC

    • PTHP

Properties:

  • identifier

  • display_name

  • vintage

  • equipment_type

  • schedules

  • has_district_heating

  • has_district_cooling

  • user_data

  • properties

Note

[1] American Society of Heating, Refrigerating and Air-Conditioning Engineers, Inc. (2007). Ashrae standard 90.1. Atlanta, GA. https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this object.

classmethod from_dict(data)[source]

Create a HVAC object from a dictionary.

Parameters:

data – A HVAC dictionary in following the format below.

{
"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
}
classmethod from_dict_abridged(data, schedule_dict)[source]

Create a HVAC object from an abridged dictionary.

Parameters:

  • data – An 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.

{
"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
}
lock()
to_dict(abridged=False)[source]

All air system dictionary representation.

Parameters:

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.

to_ideal_air_equivalent()

Get a version of this HVAC as an IdealAirSystem.

Relevant properties will be transferred to the resulting ideal air such as economizer_type, sensible_heat_recovery, latent_heat_recovery, and demand_controlled_ventilation.

unlock()
COOL_ONLY_TYPES = ('PSZAC', 'PSZAC_DCW', 'PTAC')
ECONOMIZER_TYPES = ('NoEconomizer', 'DifferentialDryBulb', 'DifferentialEnthalpy', 'DifferentialDryBulbAndEnthalpy', 'FixedDryBulb', 'FixedEnthalpy', 'ElectronicEnthalpy')
EQUIPMENT_TYPES = ('PTAC_ElectricBaseboard', 'PTAC_BoilerBaseboard', 'PTAC_DHWBaseboard', 'PTAC_GasHeaters', 'PTAC_ElectricCoil', 'PTAC_GasCoil', 'PTAC_Boiler', 'PTAC_ASHP', 'PTAC_DHW', 'PTAC', 'PTHP')
HEAT_ONLY_TYPES = ('Furnace',)
VINTAGES = ('DOE_Ref_Pre_1980', 'DOE_Ref_1980_2004', 'ASHRAE_2004', 'ASHRAE_2007', 'ASHRAE_2010', 'ASHRAE_2013', 'ASHRAE_2016', 'ASHRAE_2019')
property demand_controlled_ventilation

Get or set a boolean for whether demand controlled ventilation is present.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property economizer_type

Get or set text to indicate the type of air-side economizer.

Choose from the following options.

  • NoEconomizer

  • DifferentialDryBulb

  • DifferentialEnthalpy

  • DifferentialDryBulbAndEnthalpy

  • FixedDryBulb

  • FixedEnthalpy

  • ElectronicEnthalpy

property equipment_type

Get or set text for the system’s equipment specification.

For example, ‘VAV chiller with gas boiler reheat’.

property has_district_cooling

Get a boolean for whether the HVAC system has district cooling.

property has_district_heating

Get a boolean for whether the HVAC system has district heating.

property identifier

Get or set the text string for HVAC system identifier.

property latent_heat_recovery

Get or set a number for the effectiveness of latent heat recovery.

property properties

Get properties for extensions.

property schedules

Get an array of all the schedules associated with the HVAC system.

This property should be overwritten in each of the classes inheriting from the HVACSystem base class since each HVAC system is likely to have it’s own unique places where schedules are assigned. At a minimum, this property should return heating/cooling availability schedules.

property sensible_heat_recovery

Get or set a number for the effectiveness of sensible heat recovery.

property user_data

Get or set an optional dictionary for additional meta data for this object.

This will be None until it has been set. All keys and values of this dictionary should be of a standard Python type to ensure correct serialization of the object to/from JSON (eg. str, float, int, list, dict)

property vintage

Get or set text to indicate the vintage of the template system.

Choose from the following options:

  • DOE_Ref_Pre_1980

  • DOE_Ref_1980_2004

  • ASHRAE_2004

  • ASHRAE_2007

  • ASHRAE_2010

  • ASHRAE_2013

  • ASHRAE_2016

  • ASHRAE_2019