honeybee_phhvac.heat_pumps module

Honeybee-PH-HVAC-Equipment: Heat-Pump Devices.

exception honeybee_phhvac.heat_pumps.UnknownPhHeatPumpTypeError(_heater_types: List[str], _received_type: str)

Bases: Exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

class honeybee_phhvac.heat_pumps.PhHeatPumpAnnual

Bases: PhHeatPumpSystem

Electric heat-pump with only Annual performance values.

ToString()

base_attrs_from_dict(_input_dict: PhHeatPumpSystem) → PhHeatPumpSystem

check_dict_type(_input_dict: Dict[str, Any]) → None

Check that the input dict type is correct for the Heat Pump System being constructed.

duplicate() → PhHeatPumpAnnual

Duplicate the System.

classmethod from_dict(_input_dict: Dict[str, Any]) → PhHeatPumpAnnual

move(moving_vec3D)

Move the System’s elements along a vector.

Parameters:

moving_vec3D – A Vector3D with the direction and distance to move the ray.

reflect(normal_vec3D, origin_pt3D)

Reflected the System’s elements across a plane with the input normal vector and origin_pt3D.

Parameters:

• normal_vec3D – A Vector3D representing the normal vector for the plane across which the line segment will be reflected. THIS VECTOR MUST BE NORMALIZED.

• origin_pt3D – A Point3D representing the origin_pt3D from which to reflect.

rotate(axis_vec3D, angle_degrees, origin_pt3D)

Rotate the System’s elements by a certain angle around an axis_vec3D and origin_pt3D.

Right hand rule applies: If axis_vec3D has a positive orientation, rotation will be clockwise. If axis_vec3D has a negative orientation, rotation will be counterclockwise.

Parameters:

• axis_vec3D – A Vector3D axis_vec3D representing the axis_vec3D of rotation.

• angle_degrees – An angle for rotation in degrees.

• origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

rotate_xy(angle_degrees, origin_pt3D)

Rotate the System’s elements counterclockwise in the XY plane by a certain angle.

Parameters:

• angle_degrees – An angle in degrees.

• origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

scale(scale_factor, origin_pt3D=None)

Scale the System’s elements by a factor from an origin_pt3D point.

Parameters:

• scale_factor – A number representing how much the line segment should be scaled.

• origin_pt3D – A Point3D representing the origin_pt3D from which to scale. If None, it will be scaled from the World origin_pt3D (0, 0, 0).

to_dict() → Dict[str, Any]

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 identifier

property identifier_short: str

property key

class honeybee_phhvac.heat_pumps.PhHeatPumpCombined

Bases: PhHeatPumpSystem

ToString()

base_attrs_from_dict(_input_dict: PhHeatPumpSystem) → PhHeatPumpSystem

check_dict_type(_input_dict: Dict[str, Any]) → None

Check that the input dict type is correct for the Heat Pump System being constructed.

duplicate() → PhHeatPumpSystem

Duplicate the System.

classmethod from_dict(input_dict: Dict[str, Any]) → PhHeatPumpSystem

move(moving_vec3D)

Move the System’s elements along a vector.

Parameters:

moving_vec3D – A Vector3D with the direction and distance to move the ray.

reflect(normal_vec3D, origin_pt3D)

Reflected the System’s elements across a plane with the input normal vector and origin_pt3D.

Parameters:

• normal_vec3D – A Vector3D representing the normal vector for the plane across which the line segment will be reflected. THIS VECTOR MUST BE NORMALIZED.

• origin_pt3D – A Point3D representing the origin_pt3D from which to reflect.

rotate(axis_vec3D, angle_degrees, origin_pt3D)

Rotate the System’s elements by a certain angle around an axis_vec3D and origin_pt3D.

Right hand rule applies: If axis_vec3D has a positive orientation, rotation will be clockwise. If axis_vec3D has a negative orientation, rotation will be counterclockwise.

Parameters:

• axis_vec3D – A Vector3D axis_vec3D representing the axis_vec3D of rotation.

• angle_degrees – An angle for rotation in degrees.

• origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

rotate_xy(angle_degrees, origin_pt3D)

Rotate the System’s elements counterclockwise in the XY plane by a certain angle.

Parameters:

• angle_degrees – An angle in degrees.

• origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

scale(scale_factor, origin_pt3D=None)

Scale the System’s elements by a factor from an origin_pt3D point.

Parameters:

• scale_factor – A number representing how much the line segment should be scaled.

• origin_pt3D – A Point3D representing the origin_pt3D from which to scale. If None, it will be scaled from the World origin_pt3D (0, 0, 0).

to_dict() → Dict[str, Any]

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 identifier

property identifier_short: str

property key

class honeybee_phhvac.heat_pumps.PhHeatPumpCoolingParams

Bases: object

A Collection of Cooling Parameters for various types of systems.

ToString() → str

duplicate() → PhHeatPumpCoolingParams

classmethod from_dict(_input_dict: Dict[str, Any]) → PhHeatPumpCoolingParams

to_dict() → Dict[str, Any]

class honeybee_phhvac.heat_pumps.PhHeatPumpCoolingParams_Base

Bases: _PhHVACBase

Base class for all HBPH-Cooling-Parameters.

ToString()

base_attrs_from_dict(_input_dict: PhHeatPumpCoolingParams_Base) → PhHeatPumpCoolingParams_Base

duplicate() → PhHeatPumpCoolingParams_Base

classmethod from_dict(input_dict)

to_dict() → Dict[str, Any]

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 identifier

property identifier_short: str

property key

class honeybee_phhvac.heat_pumps.PhHeatPumpCoolingParams_Dehumidification

Bases: PhHeatPumpCoolingParams_Base

Cooling via dedicated dehumidification system.

ToString()

base_attrs_from_dict(_input_dict: PhHeatPumpCoolingParams_Base) → PhHeatPumpCoolingParams_Base

duplicate() → PhHeatPumpCoolingParams_Dehumidification

classmethod from_dict(_input_dict: Dict[str, Any]) → PhHeatPumpCoolingParams_Dehumidification

to_dict() → Dict[str, Any]

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 identifier

property identifier_short: str

property key

class honeybee_phhvac.heat_pumps.PhHeatPumpCoolingParams_Panel

Bases: PhHeatPumpCoolingParams_Base

Cooling via radiant panels.

ToString()

base_attrs_from_dict(_input_dict: PhHeatPumpCoolingParams_Base) → PhHeatPumpCoolingParams_Base

duplicate() → PhHeatPumpCoolingParams_Panel

classmethod from_dict(_input_dict: Dict[str, Any]) → PhHeatPumpCoolingParams_Panel

to_dict() → Dict[str, Any]

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 identifier

property identifier_short: str

property key

class honeybee_phhvac.heat_pumps.PhHeatPumpCoolingParams_Recirculation

Bases: PhHeatPumpCoolingParams_Base

Cooling via a ‘recirculation’ system (typical AC).

ToString()

base_attrs_from_dict(_input_dict: PhHeatPumpCoolingParams_Base) → PhHeatPumpCoolingParams_Base

duplicate() → PhHeatPumpCoolingParams_Recirculation

classmethod from_dict(_input_dict: Dict[str, Any]) → PhHeatPumpCoolingParams_Recirculation

to_dict() → Dict[str, Any]

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 identifier

property identifier_short: str

property key

class honeybee_phhvac.heat_pumps.PhHeatPumpCoolingParams_Ventilation

Bases: PhHeatPumpCoolingParams_Base

Cooling via the Fresh-Air Ventilation System (ERV).

ToString()

base_attrs_from_dict(_input_dict: PhHeatPumpCoolingParams_Base) → PhHeatPumpCoolingParams_Base

duplicate() → PhHeatPumpCoolingParams_Ventilation

classmethod from_dict(_input_dict: Dict[str, Any]) → PhHeatPumpCoolingParams_Ventilation

to_dict() → Dict[str, Any]

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 identifier

property identifier_short: str

property key

class honeybee_phhvac.heat_pumps.PhHeatPumpRatedMonthly

Bases: PhHeatPumpSystem

Electric heat-pump with 2 separate monthly performance values.

ToString()

base_attrs_from_dict(_input_dict: PhHeatPumpSystem) → PhHeatPumpSystem

check_dict_type(_input_dict: Dict[str, Any]) → None

Check that the input dict type is correct for the Heat Pump System being constructed.

duplicate() → PhHeatPumpRatedMonthly

Duplicate the System.

classmethod from_dict(_input_dict: Dict[str, Any]) → PhHeatPumpRatedMonthly

move(moving_vec3D)

Move the System’s elements along a vector.

Parameters:

moving_vec3D – A Vector3D with the direction and distance to move the ray.

reflect(normal_vec3D, origin_pt3D)

Reflected the System’s elements across a plane with the input normal vector and origin_pt3D.

Parameters:

• normal_vec3D – A Vector3D representing the normal vector for the plane across which the line segment will be reflected. THIS VECTOR MUST BE NORMALIZED.

• origin_pt3D – A Point3D representing the origin_pt3D from which to reflect.

rotate(axis_vec3D, angle_degrees, origin_pt3D)

Rotate the System’s elements by a certain angle around an axis_vec3D and origin_pt3D.

Right hand rule applies: If axis_vec3D has a positive orientation, rotation will be clockwise. If axis_vec3D has a negative orientation, rotation will be counterclockwise.

Parameters:

• axis_vec3D – A Vector3D axis_vec3D representing the axis_vec3D of rotation.

• angle_degrees – An angle for rotation in degrees.

• origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

rotate_xy(angle_degrees, origin_pt3D)

Rotate the System’s elements counterclockwise in the XY plane by a certain angle.

Parameters:

• angle_degrees – An angle in degrees.

• origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

scale(scale_factor, origin_pt3D=None)

Scale the System’s elements by a factor from an origin_pt3D point.

Parameters:

• scale_factor – A number representing how much the line segment should be scaled.

• origin_pt3D – A Point3D representing the origin_pt3D from which to scale. If None, it will be scaled from the World origin_pt3D (0, 0, 0).

to_dict() → Dict[str, Any]

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 identifier

property identifier_short: str

property key

property monthly_COPS

property monthly_temps

class honeybee_phhvac.heat_pumps.PhHeatPumpSystem

Bases: _PhHVACBase

Base class for all HBPH-Cooling-Systems.

ToString()

base_attrs_from_dict(_input_dict: PhHeatPumpSystem) → PhHeatPumpSystem

check_dict_type(_input_dict: Dict[str, Any]) → None

Check that the input dict type is correct for the Heat Pump System being constructed.

duplicate() → PhHeatPumpSystem

Duplicate the System.

classmethod from_dict(input_dict: Dict[str, Any]) → PhHeatPumpSystem

move(moving_vec3D)

Move the System’s elements along a vector.

Parameters:

moving_vec3D – A Vector3D with the direction and distance to move the ray.

reflect(normal_vec3D, origin_pt3D)

Reflected the System’s elements across a plane with the input normal vector and origin_pt3D.

Parameters:

• normal_vec3D – A Vector3D representing the normal vector for the plane across which the line segment will be reflected. THIS VECTOR MUST BE NORMALIZED.

• origin_pt3D – A Point3D representing the origin_pt3D from which to reflect.

rotate(axis_vec3D, angle_degrees, origin_pt3D)

Rotate the System’s elements by a certain angle around an axis_vec3D and origin_pt3D.

Right hand rule applies: If axis_vec3D has a positive orientation, rotation will be clockwise. If axis_vec3D has a negative orientation, rotation will be counterclockwise.

Parameters:

• axis_vec3D – A Vector3D axis_vec3D representing the axis_vec3D of rotation.

• angle_degrees – An angle for rotation in degrees.

• origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

rotate_xy(angle_degrees, origin_pt3D)

Rotate the System’s elements counterclockwise in the XY plane by a certain angle.

Parameters:

• angle_degrees – An angle in degrees.

• origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

scale(scale_factor, origin_pt3D=None)

Scale the System’s elements by a factor from an origin_pt3D point.

Parameters:

• scale_factor – A number representing how much the line segment should be scaled.

• origin_pt3D – A Point3D representing the origin_pt3D from which to scale. If None, it will be scaled from the World origin_pt3D (0, 0, 0).

to_dict() → Dict[str, Any]

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 identifier

property identifier_short: str

property key

class honeybee_phhvac.heat_pumps.PhHeatPumpSystemBuilder

Bases: object

Constructor class for HBPH-CoolingSystems

ToString()

classmethod from_dict(_input_dict: Dict[str, Any]) → PhHeatPumpSystem

Find the right heat-pump constructor class from the module based on the ‘type’ name.