honeybee_ies.writer module

honeybee_ies.writer.model_to_gem(model: Model, shade_thickness: float = 0.0)[source]

Generate an IES GEM string representation of a Model.

Parameters:

  • model – A honeybee model.

  • shade_thickness – The thickness of the shade face in meters. This value will be used to extrude shades with no group id. IES doesn’t consider the effect of shades with no thickness in SunCalc. This function extrudes the geometry to create a closed volume for the shade. (Default: 0.0).

Returns:

Text string representation of the contents of a GEM file derived from the input model.

honeybee_ies.writer.model_to_ies(model: Model, folder: str = '.', name: str = None, shade_thickness: float = 0.0, write_id_mapper=True) → Path[source]

Export a honeybee model to an IES GEM file.

Parameters:

  • model – A honeybee model.

  • folder – Path to target folder to export the file. Default is current folder.

  • name – An optional name for exported file. By default the name of the model will be used.

  • shade_thickness – The thickness of the shade face in meters. This value will be used to extrude shades with no group id. IES doesn’t consider the effect of shades with no thickness in SunCalc. This function extrudes the geometry to create a closed volume for the shade. Default: 0.0

  • write_id_mapper – A boolean to indicate if the id mapper file should be written next to the gem file. It is a JSON file that maps the original identifier of the rooms in the honeybee model to the new identifier in GEM file.

Returns:

Path to exported GEM file.

honeybee_ies.writer.room_to_ies(room: Room, shade_thickness: float = 0.01) → str[source]

Convert a Honeybee Shade to a GEM string.

Parameters:

  • room – A Honeybee Room.

  • shade_thickness – The thickness of the shade face in meters. This value will be used to extrude shades with no group id. IES doesn’t consider the effect of shades with no thickness in SunCalc. This function extrudes the geometry to create a closed volume for the shade. Default: 0.01

Returns:

A formatted string that represents this room in GEM format.

honeybee_ies.writer.shade_meshes_to_ies(shades: List[ShadeMesh]) → str[source]

Convert a list of ShadeMeshes to a GEM string.

Parameters:

shades – A list of ShadeMeshes.

Returns:

A formatted string that represents this shade in GEM format.

honeybee_ies.writer.shades_to_ies(shades: List[Shade], thickness: float = 0.01) → str[source]

Convert a list of Shades to a GEM string.

Parameters:

  • shades – A list of Shade faces.

  • thickness – The thickness of the shade face in meters. This value will be used to extrude shades with no group id. IES doesn’t consider the effect of shades with no thickness in SunCalc. This function extrudes the geometry to create a closed volume for the shade. Default: 0.01

Returns:

A formatted string that represents this shade in GEM format.