> For the complete documentation index, see [llms.txt](https://docs.ladybug.tools/hb-radiance-primer/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ladybug.tools/hb-radiance-primer/components/3_recipes/breeam_daylight_4b.md).

# BREEAM Daylight 4b

![](/files/xYwQ5g9lHA4kRp7gcas3)

![](/files/VSIJaSksqjS1aD5PfE3o) - [\[source code\]](https://github.com/ladybug-tools/honeybee-grasshopper-radiance/blob/master/honeybee_grasshopper_radiance/src//HB%20BREEAM%20Daylight%204b.py)

Run a BREEAM Hea 01 (Path 4b) daylighting compliance study for a Honeybee model.

This recipe executes a climate-based annual simulation using a 2-phase daylight coefficient method to assess compliance against BREEAM daylighting criteria.

SIMULATION REQUIREMENTS: \* ROOMS: The model must consist of Honeybee Rooms. \* PROGRAMS: The rooms must have Honeybee Energy programs assigned. Because BREEAM maps distinct daylight targets depending on room function, this component outputs a program breakdown by individual space type or program categories. The program is only used to categorize the room type, and as such only the program name is important. List of valid program names: - BREEAM::Education\_buildings::Preschools - BREEAM::Education\_buildings::Higher\_education - BREEAM::Healthcare\_buildings::Staff\_and\_public\_areas - BREEAM::Healthcare\_buildings::Patients\_areas\_and\_consulting\_rooms - BREEAM::Multi\_residential\_buildings::Kitchen - BREEAM::Multi\_residential\_buildings::Living\_rooms\_dining\_rooms\_studies - BREEAM::Multi\_residential\_buildings::Non\_residential\_or\_communal\_spaces - BREEAM::Retail\_buildings::Sales\_areas - BREEAM::Retail\_buildings::Other\_occupied\_areas - BREEAM::Prison\_buildings::Cells\_and\_custody\_cells - BREEAM::Prison\_buildings::Internal\_association\_or\_atrium - BREEAM::Prison\_buildings::Patient\_care\_spaces - BREEAM::Prison\_buildings::Teaching\_lecture\_and\_seminar\_spaces - BREEAM::Office\_buildings::Occupied\_spaces - BREEAM::Creche\_buildings::Occupied\_spaces - BREEAM::Other\_buildings::Occupied\_spaces

NOTE: If a room has no program assigned, BREEAM::Office\_buildings::Occupied\_spaces will be used as the default program.

### Inputs

* #### model \[Required]

A Honeybee Model for which BREEAM 4b will be simulated. Note that this model must have grids assigned to it. It is also required that the model consists of rooms and have HB-Energy programs assigned to them.

* #### wea \[Required]

A Wea object produced from the Wea components that are under the Light Sources tab. This can also be the path to a .wea or a .epw file. Note that the Wea must have a timestep of 1 to be used with this recipe.

* #### north

A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. This can also be Vector for the direction to North. (Default: 0).

* #### grid\_filter

Text for a grid identifer or a pattern to filter the sensor grids of the model that are simulated. For instance, first\_floor\_\* will simulate only the sensor grids that have an identifier that starts with first\_floor\_. By default, all grids in the model will be simulated.

* #### radiance\_par

Text for the radiance parameters to be used for ray tracing. (Default: -ab 2 -ad 5000 -lw 2e-05).

* #### run\_settings

Settings from the "HB Recipe Settings" component that specify how the recipe should be run. This can also be a text string of recipe settings.

* #### run \[Required]

Set to True to run the recipe and get results. This input can also be the integer "2" to run the recipe silently.

### Outputs

* #### report

Reports, errors, warnings, execution logs, etc.

* #### results

Raw result files (.ill) that contain illuminance matrices for each sensor at each hour of the simulation. These can be postprocessed using various components under the 4::Results sub-tab.

* #### summary

A summary containing the number of BREEAM credits achieved and a summary of the total area meeting the baseline criteria. This summary is organized per building type.

* #### program\_summary

A detailed breakdown of compliance percentages organized by specific space and program types.
