honeybee_radiance_postprocess.en17037 module¶

Functions for EN 17037 post-processing.

honeybee_radiance_postprocess.en17037.en17037_compute(array: ndarray, grid_info: dict, area_array: ndarray = None) → dict[source]¶

Compute EN 17037 metrics for a 2D NumPy array.

Parameters:

array – A 2D NumPy array (sensors x occupied hours).
grid_info – A grid information dictionary that must contain at least full_id and count.
area_array – An optional 1D NumPy array containing the face areas corresponding to each sensor point.

Returns:

dict – Nested result dictionary with the following structure:

{
    'grid_id': str,
    'grid_count': int,
    'target_types': {
        '<target_type>': {
            'compliance_level': np.ndarray,
            'levels': {
                '<level>': {
                    'threshold': int,
                    'da': np.ndarray,
                    'sda': float,
                    'passes': bool,
                },
            },
        },
    },
}

honeybee_radiance_postprocess.en17037.en17037_to_files(array: ndarray, metrics_folder: Path, grid_info: dict, area_array: ndarray = None) → dict[source]¶

Compute EN 17037 metrics and write the results to metrics_folder.

Parameters:

array – A 2D NumPy array.
metrics_folder – Output folder. Created if it does not exist.
grid_info – A grid information dictionary.
area_array – A 2D NumPy array representing the area of each sensor.

Returns:

dict – The result dictionary.

honeybee_radiance_postprocess.en17037.en17037_to_folder(results: str | AnnualDaylight, schedule: list, states: DynamicSchedule = None, grids_filter: str = '*', sub_folder: str = 'en17037') → Path[source]¶

Compute annual EN 17037 metrics in a folder and write them in a subfolder.

The results is an output folder of annual daylight recipe.

Parameters:

results – Results folder.
schedule – An annual schedule for 8760 hours of the year as a list of values. This should be a daylight hours schedule.
states – A dictionary of states. Defaults to None.
grids_filter – A pattern to filter the grids. By default all the grids will be processed.
sub_folder – An optional relative path for the subfolder where results are written. Default: en17037.

Returns:

Path – Path to the results folder.