API Reference phius

phius

Phius Certification Data Class

Source: honeybee_ph/phius.py


PhiusBuildingCertificationProgram

Phius building certification program type enumeration.

Inherits from: enumerables.CustomEnum

Values

ValueMeaning
"1-Default"Default (unspecified) certification program.
"2-PHIUS 2015"
"3-PHIUS 2018"
"4-Italian"Italian certification standard.
"5-PHIUS 2018 CORE"
"6-PHIUS 2018 ZERO"
"7-PHIUS 2021 CORE"
"8-PHIUS 2021 ZERO"

PhiusBuildingCategoryType

Phius building category type enumeration.

Inherits from: enumerables.CustomEnum

Values

ValueMeaning
"1-RESIDENTIAL BUILDING"
"2-NON-RESIDENTIAL BUILDING"

PhiusBuildingUseType

Phius building use type enumeration.

Inherits from: enumerables.CustomEnum

Values

ValueMeaning
"1-RESIDENTIAL"Residential use.
""
""
"4-OFFICE/ADMINISTRATIVE BUILDING"
"5-SCHOOL"School use.
"6-OTHER"Other use type.
"7-UNDEFINED/UNFINISHED"Undefined or unfinished use type.

PhiusBuildingStatus

Phius building status enumeration.

Inherits from: enumerables.CustomEnum

Values

ValueMeaning
"1-IN_PLANNING"Building is in the planning phase.
"2-UNDER_CONSTRUCTION"Building is under construction.
"3-COMPLETE"Building is complete.

PhiusBuildingType

Phius building type enumeration.

Inherits from: enumerables.CustomEnum

Values

ValueMeaning
"1-NEW_CONSTRUCTION"New construction project.
"2-RETROFIT"Retrofit of an existing building.
"3-MIXED"Mixed new construction and retrofit.

PhiusCertification

Phius certification configuration and performance targets for a building.

Inherits from: _base._Base

Attributes

AttributeTypeDescription
localization_selection_typeintLocalization selection type identifier.
PHIUS2021_heating_demandfloatPHIUS 2021 heating demand target (kBtu/ft2/yr).
PHIUS2021_cooling_demandfloatPHIUS 2021 cooling demand target (kBtu/ft2/yr).
PHIUS2021_heating_loadfloatPHIUS 2021 heating load target (Btu/h/ft2).
PHIUS2021_cooling_loadfloatPHIUS 2021 cooling load target (Btu/h/ft2).
int_gains_evap_per_personintEvaporative internal gains per person (W/person).
int_gains_flush_heat_lossboolWhether to account for flush heat loss.
int_gains_num_toiletsintNumber of toilets in the building.
int_gains_toilet_room_util_patOptional[unknown]Toilet room utilization pattern name.
int_gains_use_school_defaultsboolWhether to use school default internal gains.
int_gains_dhw_marginal_perf_ratioOptional[unknown]DHW marginal performance ratio.
icfa_override`floatNone`

Properties

PropertyTypeDescription
certification_programPhiusBuildingCertificationProgramThe Phius certification program for this building.
building_category_typePhiusBuildingCategoryTypeThe Phius building category type (residential or non-residential).
building_use_typePhiusBuildingUseTypeThe Phius building use type (residential, school, office, etc.).
building_statusPhiusBuildingStatusThe Phius building status (planning, construction, or complete).
building_typePhiusBuildingTypeThe Phius building type (new construction, retrofit, or mixed).

Methods

move(moving_vec3D)

Move the Phius Certification Object along a vector.

ArgTypeDescription
moving_vec3DVector3DA Vector3D with the direction and distance to move the ray.

Returns: PhiusCertification

rotate(axis_vec3D, angle_degrees, origin_pt3D)

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

ArgTypeDescription
axis_vec3DVector3DA Vector3D axis representing the axis of rotation.
angle_degreesfloatAn angle for rotation in degrees.
origin_pt3DPoint3DA Point3D for the origin around which the object will be rotated.

Returns: PhiusCertification

rotate_xy(angle_degrees, origin_pt3D)

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

ArgTypeDescription
angle_degreesfloatAn angle in degrees.
origin_pt3DPoint3DA Point3D for the origin around which the object will be rotated.

Returns: PhiusCertification

reflect(plane)

Reflect the Phius Certification Object across a plane.

ArgTypeDescription
planePlaneA Plane representing the plane across which to reflect.

Returns: PhiusCertification

scale(scale_factor, origin_pt3D)

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

ArgTypeDescription
scale_factorfloatA number representing how much the object should be scaled.
origin_pt3DOptional[Point3D]A Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

Returns: PhiusCertification