honeybee_doe2.grouping module

Methods for grouping rooms to comply with INP rules.

honeybee_doe2.grouping.group_rooms_by_doe2_hvac(model, hvac_mapping)[source]

Group Honeybee Rooms according to HVAC logic.

Parameters:
  • model – A Honeybee Model for which Rooms will be grouped for HVAC assignment.

  • hvac_mapping

    Text to indicate how HVAC systems should be assigned. Model will use only one HVAC system for the whole model and AssignedHVAC will follow how the HVAC systems have been assigned to the Rooms.properties.energy.hvac. Choose from the options below.

    • Room

    • Model

    • AssignedHVAC

Returns:

A tuple with three elements.

  • room_groups: A list of lists where each sub-list contains Honeybee Rooms that should ave the same HVAC system.

  • hvac_names: A list of text strings that align with the room_groups and contain suggested names for the DOE-2 HVAC systems.

honeybee_doe2.grouping.group_rooms_by_doe2_level(rooms, model_tolerance)[source]

Group Honeybee Rooms according to acceptable floor levels in DOE-2.

This means that not only will Rooms be on separate DOE-2 levels if their floor heights differ but also Rooms that share the same floor height but are disconnected from one another in plan will also be separate levels. For example, when the model is of two towers on a plinth, each tower will get its own separate level group.

Parameters:
  • rooms – A list of Honeybee Rooms to be grouped.

  • model_tolerance – The tolerance of the model that the Rooms originated from.

Returns:

A tuple with three elements.

  • room_groups: A list of lists where each sub-list contains Honeybee Rooms that should be on the same DOE-2 level.

  • level_geometries: A list of Face3D with the same length as the room_groups, which contains the geometry that represents each floor level. These geometries will always be pointing upwards so that their vertices are counter-clockwise when viewed from above. They will also have colinear vertices removed such that they are ready to be translated to INP POLYGONS.

  • level_names: A list of text strings that align with the level geometry and contain suggested names for the DOE-2 levels.