honeybee_ph.phi module

PHI Certification Settings Class.

class honeybee_ph.phi.EnumProperty(attribute_name: str, _phpp_version: int = 9)

Bases: object

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

allowed_inputs = {'building_category_type': {9: ['1-RESIDENTIAL BUILDING', '2-NON-RESIDENTIAL BUILDING'], 10: []}, 'building_use_type': {9: ['_', '_', '_', '_', '_', '_', '_', '_', '_', '10-DWELLING', '11-NURSING HOME / STUDENTS', '12-OTHER', '_', '_', '_', '_', '_', '_', '_', '20-OFFICE / ADMIN. BUILDING', '21-SCHOOL', '22-OTHER'], 10: ['_', '_', '_', '_', '_', '_', '_', '_', '_', '10-RESIDENTIAL BUILDING: RESIDENTIAL (DEFAULT)', '_', '12-RESIDENTIAL BUILDING: OTHER', '_', '_', '_', '_', '_', '_', '_', '20-NON-RES BUILDING: OFFICE/ADMINISTRATION', '21-NON-RES BUILDING: SCHOOL HALF-DAYS (< 7 H)', '22-NON-RES BUILDING: SCHOOL FULL-TIME (≥ 7 H)', '23-NON-RES.: OTHER']}, 'certification_class': {9: ['1-CLASSIC', '2-PLUS', '3-PREMIUM'], 10: ['_', '_', '_', '_', '_', '_', '_', '_', '_', '10-CLASSIC | PER (RENEWABLE)', '11-CLASSIC | PE (NON-RENEWABLE)', '_', '_', '_', '_', '_', '_', '_', '_', '20-PLUS | PER (RENEWABLE)', '_', '_', '_', '_', '_', '_', '_', '_', '_', '30-PREMIUM | PER (RENEWABLE)']}, 'certification_type': {9: ['1-PASSIVE HOUSE', '2-ENERPHIT', '3-PHI LOW ENERGY BUILDING', '4-OTHER'], 10: ['_', '_', '_', '_', '_', '_', '_', '_', '_', '10-PASSIVE HOUSE', '_', '_', '_', '_', '_', '_', '_', '_', '_', '_', '21-ENERPHIT (COMPONENT METHOD)', '22-ENERPHIT (ENERGY DEMAND METHOD)', '_', '_', '_', '_', '_', '_', '_', '30-PHI LOW ENERGY BUILDING', '_', '_', '_', '_', '_', '_', '_', '_', '_', '40-OTHER']}, 'enerphit_type': {9: ['1-COMPONENT METHOD', '2-ENERGY DEMAND METHOD'], 10: []}, 'ihg_type': {9: ['_', '2-STANDARD', "3-PHPP CALCULATION ('IHG' WORKSHEET)", "4-PHPP CALCULATION ('IHG NON-RES' WORKSHEET)"], 10: ['_', '2-STANDARD', "3-PHPP-CALCULATION ('IHG' WORKSHEET)", "4-PHPP-CALCULATION ('IHG NON-RES' WORKSHEET)"]}, 'occupancy_type': {9: ['1-STANDARD (ONLY FOR RESIDENTIAL BUILDINGS)', '2-USER DETERMINED'], 10: []}, 'primary_energy_type': {9: ['1-PE (NON-RENEWABLE)', '2-PER (RENEWABLE)'], 10: ['1-STANDARD', '2-PROJECT-SPECIFIC']}, 'retrofit_type': {9: ['1-NEW BUILDING', '2-RETROFIT', '3-STEP-BY-STEP RETROFIT'], 10: ['1-NEW BUILDING', '2-RETROFIT', '3-STAGED RETROFIT']}}
class honeybee_ph.phi.PHPPSettings10

Bases: _PHPPSettingsBase

Settings for PHPP v10

duplicate() → _PHPPSettingsBase
classmethod from_dict(_input_dict: Dict[str, int | str]) → _PHPPSettingsBase
to_dict() → Dict[str, int | str]
building_use_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

certification_class

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

certification_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

ihg_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

phpp_version = 10
primary_energy_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

retrofit_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

tfa_override = None
class honeybee_ph.phi.PHPPSettings9

Bases: _PHPPSettingsBase

Settings for PHPP v9

duplicate() → _PHPPSettingsBase
classmethod from_dict(_input_dict: Dict[str, int | str]) → _PHPPSettingsBase
to_dict() → Dict[str, int | str]
building_category_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

building_use_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

certification_class

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

certification_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

enerphit_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

ihg_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

occupancy_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

phpp_version = 9
primary_energy_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

retrofit_type

Descriptor for creating and managing the PHI-Cert Enum items.

This Descriptor will create a new Enum type when it is called using the attribute name and the phpp_version #, This new enum will be used to manage the allowable values and clean / filter the user inputs.

tfa_override = None
class honeybee_ph.phi.PhiCertification(phpp_version: int = 9)

Bases: _Base

PHI PHPP Certification object with Attributes that vary by version (9 | 10)

ToString()
duplicate() → PhiCertification
classmethod from_dict(_input_dict: Dict) → PhiCertification
move(moving_vec3D: Vector3D) → PhiCertification

Move the Phius Certification Object along a vector.

Parameters:

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

reflect(plane: Plane) → PhiCertification

Reflected the Phius Certification Object across a plane.

Parameters:

normal_vec3D – A Plane representing the plane across which to reflect.

rotate(axis_vec3D: Vector3D, angle_degrees: float, origin_pt3D: Point3D) → PhiCertification

Rotate the Phius Certification Object by a certain angle around an axis and origin.

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

Parameters:

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

  • angle_degrees – An angle for rotation in degrees.

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

rotate_xy(angle_degrees: float, origin_pt3D: Point3D) → PhiCertification

Rotate the Phius Certification Object counterclockwise in the XY plane by a certain angle.

Parameters:

  • angle_degrees – An angle in degrees.

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

scale(scale_factor: float, origin_pt3D: Point3D | None = None) → PhiCertification

Scale the Phius Certification Object by a factor from an origin point.

Parameters:

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

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

set_base_attrs_from_source(_source)
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