honeybee_energy.result.match module

Utilities for matching Model geometry with energy simulation results.

honeybee_energy.result.match.match_faces_to_data(data_collections, faces)[source]

Match honeybee faces/sub-faces to data collections from SQLiteResult.

This method will correctly match triangulated apertures and doors with a merged version of the relevant data_collections.

Parameters:

  • data_collections – An array of data collections that will be matched to the input faces Data collections can be of any class (eg. MonthlyCollection, DailyCollection) but they should all have headers with metadata dictionaries with ‘Surface’ keys. These keys will be used to match the data in the collections to the input faces.

  • faces – An array of honeybee Faces, Apertures, and/or Doors which will be matched to the data_collections. Note that a given input Face should NOT have its child Apertures or Doors as a separate item.

Returns:

An array of tuples that contain matched faces/sub-faces and data collections. All tuples have a length of 2 with the following:

  • face – A honeybee Face, Aperture, or Door object.

  • data_collection – A data collection that matches the Face, Aperture, or Door.

honeybee_energy.result.match.match_rooms_to_data(data_collections, rooms, invert_multiplier=False, space_based=False)[source]

Match honeybee Rooms to the Zone-level data collections from SQLiteResult.

This method ensures that Room multipliers are correctly output for a given EnergyPlus output.

Parameters:

  • data_collections – An array of data collections that will matched to simulation results. Data collections can be of any class (eg. MonthlyCollection, DailyCollection) but they should all have headers with metadata dictionaries with ‘Zone’ or ‘System’ keys. These keys will be used to match the data in the collections to the input rooms.

  • rooms – An array of honeybee Rooms, which will be matched to the data_collections. The length of these Rooms does not have to match the data_collections.

  • invert_multiplier – Boolean to note whether the output room multiplier should be included when the data type values already account for the multiplier (False) or when they do not (True). (Default: False).

  • space_based – Boolean to note whether the result is reported on the EnergyPlus Space level instead of the Zone level. In this case, the matching to the Room will account for the fact that the Space name is the Room name with _Space added to it. (Default: False).

Returns:

An array of tuples that contain matched rooms and data collections. All tuples have a length of 3 with the following:

  • room – A honeybee Room object.

  • data_collection – A data collection that matches the honeybee Room.

  • multiplier – An integer for the Room multiplier, which may be useful for calculating total results.