honeybee_energy_ph.load.ph_equipment module

HB-PH Electric Equipment and Appliances.

class honeybee_energy_ph.load.ph_equipment.PhClothesDryer(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhClothesDryer

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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 dryer_type

property identifier

property identifier_short

class honeybee_energy_ph.load.ph_equipment.PhClothesWasher(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhClothesWasher

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

property water_connection

class honeybee_energy_ph.load.ph_equipment.PhCooktop(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Return annual energy consumption [kWh] for a single dwelling.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhCooktop

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → dict

property cooktop_type

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

class honeybee_energy_ph.load.ph_equipment.PhCustomAnnualElectric(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhCustomAnnualElectric

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhCustomAnnualLighting(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhCustomAnnualLighting

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhCustomAnnualMEL(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhCustomAnnualMEL

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhDishwasher(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhDishwasher

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

property water_connection

class honeybee_energy_ph.load.ph_equipment.PhElevatorGearedTraction(_num_dwellings=1)

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

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

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

set_energy_demand(_num_dwellings)

Set the annual energy demand (kWh) based on the number of dwelling units

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhElevatorGearlessTraction(_num_dwellings=1)

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

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

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

set_energy_demand(_num_dwellings)

Set the annual energy demand (kWh) based on the number of dwelling units

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhElevatorHydraulic(_num_dwellings=1)

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

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

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

set_energy_demand(_num_dwellings)

Set the annual energy demand (kWh) based on the number of dwelling units

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhEquipment(_host: ProcessPhProperties | None = None, _defaults: dict = {})

Bases: _Base

Base for PH Equipment / Appliances with the common attributes.

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args, **kwargs)

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhEquipment

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhEquipmentBuilder

Bases: object

Constructor class for PH Equipment objects

ToString() → str

classmethod from_dict(_input_dict: dict, _host: ProcessPhProperties | LightingPhProperties | None = None) → PhEquipment

Find the right appliance constructor class from the module based on the ‘type’ name.

class honeybee_energy_ph.load.ph_equipment.PhEquipmentCollection(_host: ElectricEquipmentPhProperties | None = None)

Bases: object

A Collection of PH-Equipment / Appliances.

This is stored on the Honeybee-Room’s properties.energy.electric_equipment.properties.ph

ToString() → str

add_equipment(_new_equipment: PhEquipment, _key: Any | None = None) → None

Adds a new piece of Ph-Equipment to the collection.

Arguments:

• _new_equipment (PhEquipment): The new Ph Equipment to add to the set.

• _key (Any): Optional key to use for storing the equipment. If None, the

  equipment’s “identifier” will be used as the key.

Returns:

• None

duplicate(new_host: Any | None = None) → PhEquipmentCollection

classmethod from_dict(_input_dict: dict, _host: Any) → PhEquipmentCollection

items() → ItemsView[str, PhEquipment]

keys() → KeysView[str]

remove_all_equipment() → None

Reset the Collection to an empty set.

to_dict() → dict

total_collection_wattage(_hb_room: Room) → float

Returns the total annual-average-wattage of the appliances.

This value assumes constant 24/7 operation (PH-Style modeling).

Arguments:

• _hb_room (room.Room): The reference Honeybee-Room to get occupancy from.

Returns:

• (float): total Wattage of all installed PH-Equipment in the collection.

values() → ValuesView[PhEquipment]

property host: ElectricEquipmentPhProperties | None

class honeybee_energy_ph.load.ph_equipment.PhFreezer(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhFreezer

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhFridgeFreezer(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhFridgeFreezer

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhPhiusLightingExterior(_defaults: dict[str, Any] = {})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Return the annual energy consumption [kWh] for a single dwelling.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

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

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhPhiusLightingGarage(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Return the annual energy consumption [kWh] for a single dwelling.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

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

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhPhiusLightingInterior(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Return the annual energy consumption [kWh] for a single dwelling.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhPhiusLightingInterior

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhPhiusMEL(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Return annual energy consumption [kWh] for a single dwelling.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhPhiusMEL

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

class honeybee_energy_ph.load.ph_equipment.PhRefrigerator(_defaults={})

Bases: PhEquipment

ToString() → str

annual_avg_wattage(_schedule: ScheduleRuleset | None = None, *args: Any, **kwargs: Any) → float

Returns the annual average wattage of the equipment.

annual_energy_kWh(*args: Any, **kwargs: Any) → float

Returns the annual energy use (kWh) of the equipment.

apply_default_attr_values(_defaults: dict[str, Any] = {}) → None

Sets all the object attributes to default values, as specified in a “defaults” dict.

base_attrs_from_dict(_obj: PhEquipment, _input_dict: dict[str, Any]) → None

Set the base object attributes from a dictionary

Arguments:

• _obj (PhEquipment): The PH Equipment to set the attributes of.

• _input_dict (dict): The dictionary to get the attribute values from.

Returns:

• None

classmethod from_dict(_input_dict: dict) → PhRefrigerator

Set the object attributes from a dictionary

merge(other: PhEquipment, weighting_1: float = 1.0, weighting_2: float = 1.0) → PhEquipment

“Merge together two pieces of PhEquipment.

Arguments:

• other (PhEquipment): the PhEquipment to merge with.

• weighting_1 (float): Optional weighting factor to apply to the ‘self’ equipment values.

• weighting_2 (float): Optional weighting factor to apply to the ‘other’ equipment values.

Returns:

• (PhEquipment) The PhEquipment with updated attribute values.

classmethod phi_default() → PhEquipment

Return the default instance of the object.

classmethod phius_default() → PhEquipment

Return the default instance of the object.

to_dict(_abridged: bool = False) → 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

honeybee_energy_ph.load.ph_equipment.phius_elevator_by_stories(_num_of_stories: int) → Type[PhElevatorHydraulic | PhElevatorGearedTraction | PhElevatorGearlessTraction]

Return the Elevator class, based on the number of stories.