honeybee_radiance_postprocess.well.well module¶
Functions for WELL post-processing.
- honeybee_radiance_postprocess.well.well.well_annual_daylight(results: str | AnnualDaylight, daylight_hours: list, sub_folder, grids_filter: str = '*', states_schedule: dict = None)[source]¶
Calculate credits for WELL L06.
- Parameters:
results – Path to results folder or a Results class object.
daylight_hours – Schedule of daylight hours used for EN 17037
sub_folder – Relative path for a subfolder to write the output.
grids_filter – The name of a grid or a pattern to filter the grids. Defaults to ‘*’.
states_schedule – A custom dictionary of shading states. In case this is left empty, the function will calculate a shading schedule by using the shade_transmittance input. If a states schedule is provided it will check that it is complying with the 2% rule. Defaults to None.
- Returns:
well_summary: Summary of WELL analysis.
ies_lm_summary: Summary of IES LM analysis.
ies_lm_summary_grid: Summary of IES LM analysis for each grid.
- da_grids: List of daylight autonomy values for each grid. Each item
in the list is a NumPy array of DA values.
- states_schedule: A dictionary of annual shading schedules for each
aperture group.
fail_to_comply: A dictionary with the hoys where the 2% rule failed.
grids_info: Grid information.
- Return type:
Tuple