honeybee_phhvac.renewable_devices module

Honeybee-PH-HVAC-Equipment: Renewable Energy Devices.

exception honeybee_phhvac.renewable_devices.UnknownPhRenewableEnergyTypeError(_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.renewable_devices.PhPhotovoltaicDevice

Bases: PhRenewableEnergyDevice

PV System.

ToString()

base_attrs_from_dict(_input_dict: PhRenewableEnergyDevice) → PhRenewableEnergyDevice

check_dict_type(_input_dict: dict) → None

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

duplicate() → PhPhotovoltaicDevice

Duplicate the device.

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

move(moving_vec3D)

Move the device’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 device’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 device’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 device’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 device’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.renewable_devices.PhRenewableEnergyDevice

Bases: _PhHVACBase

Base class for all HBPH Renewable Energy Systems (PV, etc).

ToString()

base_attrs_from_dict(_input_dict: PhRenewableEnergyDevice) → PhRenewableEnergyDevice

check_dict_type(_input_dict: dict) → None

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

duplicate() → PhPhotovoltaicDevice

classmethod from_dict(_input_dict: Dict) → PhRenewableEnergyDevice

move(moving_vec3D)

Move the device’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 device’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 device’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 device’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 device’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

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.renewable_devices.PhRenewableEnergyDeviceBuilder

Bases: object

Constructor class for PH-Renewable-Energy-System objects.

ToString()

classmethod from_dict(_input_dict: dict[str, Any]) → PhRenewableEnergyDevice

Find the right device constructor class from the module based on the device_typename.