honeybee_radiance.postprocess.leed module

Functions for post-processing LEED daylight outputs.

honeybee_radiance.postprocess.leed.ill_pass_fail_from_folder(results_folder, glare_control=True, grids_filter='*')

Compute a list of LEED pass/fail values from a list of illuminance results.

Parameters:

• results_folder – Folder containing illuminance result (.res) files for a single irradiance simulation.

• glare_control – A boolean for whether the model has “view-preserving automatic (with manual override) glare-control devices,” which means that illuminance only needs to be above 300 lux and not between 300 and 3000 lux.

• grids_filter – A pattern to filter the grids. By default all the grids will be processed.

Returns:

A list of lists where each sub-list represents a sensor grid and contains zero/one values for whether each sensor fails/passes the LEED illuminance criteria.

honeybee_radiance.postprocess.leed.leed_illuminance_to_folder(folder, glare_control=True, grids_filter='*', sub_folder=None)

Estimate LEED daylight credits from two point-in-time illuminance folders.

Parameters:

• folder – Project folder for a LEED illuminance simulation. It should contain a HBJSON model and two sub-folders of complete point-in-time illuminance simulations labeled “9AM” and “3PM”. These two sub-folders should each have results folders that include a grids_info.json and .res files with illuminance values for each sensor. If Meshes are found for the sensor grids in the HBJSON file, they will be used to compute percentages of occupied floor area that pass vs. fail. Otherwise, all sensors will be assumed to represent an equal amount of floor area.

• glare_control – A boolean for whether the model has “view-preserving automatic (with manual override) glare-control devices,” which means that illuminance only needs to be above 300 lux and not between 300 and 3000 lux.

• grids_filter – A pattern to filter the grids. By default all the grids will be processed.

• sub_folder – Relative path for a subfolder to write the pass/fail files for each sensor grid and a space-by-space summary CSV. If None, the files will not be written and only the summary dictionary will be calculated.

Returns:

A dictionary with a summary of LEED credits in the format below. All percentages are between 0 and 100 and the floor areas are in the units system of the HBJSON model. If no sensor grid meshes were found in the HBJSON model and no areas could be associated with each mesh face, the output will not contain floor_area keys and each sensor will be assumed to occupy a similar area.

{
    "credits": 2,
    "percentage_passing": 76.2,
    "percentage_passing_9AM": 78.5,
    "percentage_passing_3PM": 82.4,
    "sensor_count_passing": 762,
    "sensor_count_passing_9AM": 785,
    "sensor_count_passing_3PM": 824,
    "total_sensor_count": 1000,
    "floor_area_passing": 762.0,
    "floor_area_passing_9AM": 785.0,
    "floor_area_passing_3PM": 824.0,
    "total_floor_area": 1000.0
}