API Reference _base

_base

PHX Passive House Mechanical Equipment base classes.

Source: PHX/_base.py


PhxUsageProfile

Flags indicating which building loads a mechanical device serves and its percent coverage.

Properties

PropertyTypeDescription
space_heatingTrue if the device used to provide space heating.
dhw_heatingTrue if the device used to provide domestic hot water heating.
coolingTrue if the device used to provide cooling.
ventilationTrue if the device used to provide ventilation.
humidificationTrue if the device used to provide humidification.
dehumidificationTrue if the device used to provide dehumidification.

PhxMechanicalDeviceParams

Base parameter set shared by all PHX mechanical devices.

Methods

staticmethod safe_add(attr_1, attr_2)

Add two optional numeric values, returning None only if both are falsy.

ArgTypeDescription
attr_1
attr_2

PhxMechanicalDevice

Base class for all PHX mechanical devices (heaters, tanks, ventilators, heat pumps, etc.).

Properties

PropertyTypeDescription
identifier
quantity

Methods

classmethod from_kwargs(**kwargs)

Allow for the create of base object from arbitrary kwarg input.

ArgTypeDescription
**kwargs