API Reference phius_mf

phius_mf

Classes for calculating Phius Multifamily Elec. Energy as per Phius Multifamily Calculator (v4.2)

Source: honeybee_energy_ph/phius_mf.py


PhiusResidentialStory

One residential story in the Phius Multifamily Calculator (v4.2).

Attributes

AttributeTypeDescription
total_floor_area_ft2calc_story_floor_area_ft2Weighted floor area in ft2.
total_number_dwellingscalc_num_dwellingsCount of dwelling units on this story.
total_number_bedroomscalc_story_bedroomsCount of bedrooms on this story.
design_occupancycalc_passive_house_occupancyPH design occupancy (number of people).
melmisc_electricalAnnual miscellaneous electrical load (kWh).
lighting_intlighting_interiorAnnual interior lighting load (kWh).
lighting_extlighting_exteriorAnnual exterior lighting load (kWh).
lighting_garagelighting_garageAnnual garage lighting load (kWh).
story_numberZero-padded story number string.

Properties

PropertyTypeDescription
story_numberstrReturn the story number.

Methods

calc_story_floor_area_ft2(_hb_rooms, _area_unit)

ArgTypeDescription
_hb_roomslist[Room]
_area_unitstr

Returns: float

calc_story_bedrooms(_hb_rooms)

ArgTypeDescription
_hb_roomslist[Room]

Returns: int

calc_passive_house_occupancy(_hb_rooms)

ArgTypeDescription
_hb_roomslist[Room]

Returns: float

calc_num_dwellings(_hb_rooms)

ArgTypeDescription
_hb_roomslist[Room]

Returns: int


PhiusNonResProgram

A Phius non-residential program type with lighting and MEL intensities.

Attributes

AttributeTypeDescription
namestrProgram type name.
usage_days_yrintAnnual usage days. Default: 365.
operating_hours_dayfloatDaily operating hours.
lighting_W_per_m2floatLighting power density (W/m2).
mel_kWh_m2_yrfloatAnnual MEL energy intensity (kWh/m2/yr).
mel_w_m2floatMEL power density (W/m2).

Properties

PropertyTypeDescription
lighting_W_per_ft2floatLighting power density converted to W/ft2.
mel_kWh_ft2_yrfloatAnnual MEL energy intensity converted to kWh/ft2/yr.

Methods

to_phius_mf_workbook()

Returns a text block formatted to match the Phius MF Calculator.

Returns: str

classmethod from_hb_room(_hb_room)

Returns a new PhiusNonResProgram object with attributes based on an HBE-Room.

ArgTypeDescription
_hb_roomRoom

Returns: PhiusNonResProgram


PhiusNonResProgramCollection

Collection of Phius Non-Res Program Types.

Properties

PropertyTypeDescription
programsValuesView[PhiusNonResProgram]Returns a ValuesView of the PhiusNonResPrograms in the collection dict.

Methods

add_program(_program, _key)

Adds a new PhiusNonResProgram to the collection.

ArgTypeDescription
_programPhiusNonResProgram
_key`strNone`

Returns: None

to_phius_mf_workbook()

Returns a text block formatted to match the Phius MF Calculator.

Returns: list[str]


PhiusNonResRoom

A single non-residential space for the Phius MF Calculator.

Attributes

AttributeTypeDescription
multiplierintSpace multiplier. Default: 1.
occupancy_sensorstrOccupancy sensor flag (“Y”/“N”). Default: “N”.
namestrSpace name.
reference_floor_area_m2floatReference floor area (m2).
misc_melfloatAdditional miscellaneous MEL (kWh/yr).
program_typePhiusNonResProgramThe assigned program type.

Properties

PropertyTypeDescription
reference_floor_area_ft2floatReference floor area converted to ft2.
mel_kWh_yrfloatAnnual MEL energy (kWh) excluding miscellaneous MEL.
mel_w_m2floatMEL power density from the assigned program type (W/m2).
total_mel_kWhfloatAnnual MEL energy (kWh) including miscellaneous MEL.
total_lighting_kWhfloatAnnual lighting energy (kWh).

Methods

to_phius_mf_workbook()

Returns a string representation that matches the Phius MF Calculator.

Returns: str

to_phius_mf_workbook_results()

classmethod from_ph_space(_ph_space, _area_unit)

Returns a new PhiusNonResSpace with properties based on a PH-Space.

ArgTypeDescription
_ph_spacespace.Space
_area_unitstr

Returns: PhiusNonResRoom