honeybee_energy_ph.library.programtypes module

Find Phius program data and build HBE-Programs.

exception honeybee_energy_ph.library.programtypes.MissingBaseProgramError(_data)[source]

Bases: Exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args
honeybee_energy_ph.library.programtypes.build_hb_elec_equip_from_Phius_data(_data: dict) → ElectricEquipment[source]

Returns a new HBE-Equipment Object with attributes based on the input data dict

Arguments:

  • _data (dict): The “elec_equipment” element from a full Phius data dict.

Returns:

  • (people.People): A new HB-People object.

honeybee_energy_ph.library.programtypes.build_hb_lighting_from_Phius_data(_data: dict) → Lighting[source]

Returns a new HBE-Lighting Object with attributes based on the input data dict

Arguments:

  • _data (dict): The “lighting” element from a full Phius data dict.

Returns:

  • (lighting.Lighting): A new HB-Lighting object.

honeybee_energy_ph.library.programtypes.build_hb_people_from_Phius_data(_data: dict) → People[source]

Returns a new HBE-People Object with attributes based on the input data dict

Arguments:

  • _data (dict): The “people” element from a full Phius data dict.

Returns:

  • (people.People): A new HB-People object.

honeybee_energy_ph.library.programtypes.build_hb_program_from_Phius_data(_data: dict) → ProgramType[source]

Return a new HB-Program with attributes based on an input Phius dataset

Arguments:

  • _data (dict): The full Phius datadict

Returns:

  • (ProgramType): The new Honeybee-Energy ProgramType.

honeybee_energy_ph.library.programtypes.get_all_valid_program_names_of_protocol(_protocol_name: str) → List[str][source]

Returns a list of all valid Phius program names for a given protocol.

honeybee_energy_ph.library.programtypes.get_all_valid_protocol_names() → List[str][source]

Returns a list of all valid Phius protocols.

honeybee_energy_ph.library.programtypes.load_data_from_Phius_standards(_search_key: str, _search_field: str = 'name', _protocol: str = '') → List[Dict[str, Dict]][source]

Returns a list of Phius program data as dicts.

Arguments:

  • _search_key (str): The key to search the Phius library for.

  • _search_field (str): default=’name’ | The dict field to search.

  • _protocol (str): Optional extra flag to filter by the specific ‘protocol’

Returns:

  • (list[dict]): A list of the Phius data found in the library.