honeybee.extensionutil module

A series of utility functions that are useful across several honeybee extensions.

honeybee.extensionutil.aperture_extension_dicts(aperture_list, extension_key, aperture_ext_dicts, shade_ext_dicts)

Get all Aperture property dictionaries of an extension organized by geometry type.

Parameters:

• aperture_list – A list of Aperture dictionaries.

• extension_key – Text for the key of the extension (eg. “energy”, “radiance”).

Returns:

A tuple with two elements

• aperture_ext_dicts: A list with Aperture extension property dictionaries.

• shade_ext_dicts: A list with Shade extension property dictionaries.

honeybee.extensionutil.door_extension_dicts(door_list, extension_key, door_ext_dicts, shade_ext_dicts)

Get all Door property dictionaries of an extension organized by geometry type.

Parameters:

• door_list – A list of Door dictionaries.

• extension_key – Text for the key of the extension (eg. “energy”, “radiance”).

Returns:

A tuple with two elements

• door_ext_dicts: A list with Door extension property dictionaries.

• shade_ext_dicts: A list with Shade extension property dictionaries.

honeybee.extensionutil.face_extension_dicts(face_list, extension_key, face_ext_dicts, shade_ext_dicts, aperture_ext_dicts, door_ext_dicts)

Get all Face property dictionaries of an extension organized by geometry type.

Parameters:

• face_list – A list of Room dictionaries.

• extension_key – Text for the key of the extension (eg. “energy”, “radiance”).

Returns:

A tuple with four elements

• face_ext_dicts: A list with Face extension property dictionaries.

• shade_ext_dicts: A list with Shade extension property dictionaries.

• aperture_ext_dicts: A list with Aperture extension property dictionaries.

• door_ext_dicts: A list with Door extension property dictionaries.

honeybee.extensionutil.model_extension_dicts(data, extension_key, room_ext_dicts, face_ext_dicts, shade_ext_dicts, aperture_ext_dicts, door_ext_dicts)

Get all Model property dictionaries of an extension organized by geometry type.

Note that the order in which dictionaries appear in the output lists is the same order as the geometry objects appear when requested from the model. For example, the shade_ext_dicts align with the model.shades.

Parameters:

• data – A dictionary representation of an entire honeybee-core Model.

• extension_key – Text for the key of the extension (eg. “energy”, “radiance”).

Returns:

A tuple with five elements

• room_ext_dicts: A list of Room extension property dictionaries that align with the serialized model.rooms.

• face_ext_dicts: A list of Face extension property dictionaries that align with the serialized model.faces.

• shade_ext_dicts: A list of Shade extension property dictionaries that align with the serialized model.shades plus the model.shade_meshes.

• aperture_ext_dicts: A list of Aperture extension property dictionaries that align with the serialized model.apertures.

• door_ext_dicts: A list of Door extension property dictionaries that align with the serialized model.doors.

honeybee.extensionutil.room_extension_dicts(room_list, extension_key, room_ext_dicts, face_ext_dicts, shade_ext_dicts, aperture_ext_dicts, door_ext_dicts)

Get all Room property dictionaries of an extension organized by geometry type.

Parameters:

• room_list – A list of Room dictionaries.

• extension_key – Text for the key of the extension (eg. “energy”, “radiance”).

Returns:

A tuple with five elements

• room_ext_dicts: A list with the Room extension property dictionaries.

• face_ext_dicts: A list with Face extension property dictionaries.

• shade_ext_dicts: A list with Shade extension property dictionaries.

• aperture_ext_dicts: A list with Aperture extension property dictionaries.

• door_ext_dicts: A list with Door extension property dictionaries.

honeybee.extensionutil.shade_extension_dicts(shade_list, extension_key, shade_ext_dicts)

Get all Shade property dictionaries of an extension organized by geometry type.

Parameters:

• shade_list – A list of Shade dictionaries.

• extension_key – Text for the key of the extension (eg. “energy”, “radiance”).

Returns:

shade_ext_dicts – A list with Shade extension property dictionaries.