honeybee_radiance_postprocess.ies.lm module

Functions for IES LM post-processing.

honeybee_radiance_postprocess.ies.lm.dynamic_schedule_direct_illuminance(results: str | AnnualDaylight, grids_filter: str = '*', shade_transmittance: float | dict = 0.02, use_states: bool = False) → Tuple[dict, dict][source]

Calculate a schedule of each aperture group.

This function calculates an annual shading schedule of each aperture group. Hour by hour it will select the least shaded aperture group configuration, so that no more than 2% of the sensors points receive direct illuminance of 1000 lux or more.

Parameters:

  • results – Path to results folder or a Results class object.

  • grids_filter – The name of a grid or a pattern to filter the grids. Defaults to ‘*’.

  • shade_transmittance – A value to use as a multiplier in place of solar shading. This input can be either a single value that will be used for all aperture groups, or a dictionary where aperture groups are keys, and the value for each key is the shade transmittance. Values for shade transmittance must be 1 > value > 0. Defaults to 0.02.

  • use_states – A boolean to note whether to use the simulated states. Set to True to use the simulated states. The default is False which will use the shade transmittance instead.

Returns:

A tuple with a dictionary of the annual schedule and a

dictionary of hours where no shading configuration comply with the 2% rule.

Return type:

Tuple

honeybee_radiance_postprocess.ies.lm.shade_transmittance_per_light_path(light_paths: list, shade_transmittance: float | dict, shd_trans_dict: dict) → dict[source]

Filter shade_transmittance by light paths and add default multiplier.

Parameters:

  • light_paths – A list of light paths.

  • shade_transmittance – A value to use as a multiplier in place of solar shading. This input can be either a single value that will be used for all aperture groups, or a dictionary where aperture groups are keys, and the value for each key is the shade transmittance. Values for shade transmittance must be 1 > value > 0.

  • shd_trans_dict – A dictionary used to store shade transmittance value for each aperture group.

Returns:

A dictionary with filtered light paths.