annual_daylight
Calculate annual daylight metrics (DA, cDA, UDI, sDA, ASE) for grid points using Radiance simulation, returning per-point and spatial results with optional occupancy and shading.
Instructions
Annual climate-based daylight metrics on the grid: per-point DA/cDA/UDI + spatial sDA/ASE.
channel_scenes: 1 dict (3ch) or 3 dicts (9ch), each {materials:[paths], geometry:path, sky_color:[r,g,b]} -- same shape as run_annual. points: inline rows or a .pts path; OR pass sensor_set='name' (created via the sensors tool). ASE uses a dedicated direct-only (-ab 0) pass. occupancy: optional per-timestep 0/1 mask (defaults to weekday occupied_start..end, Monday-anchored 8760-h). Runs Radiance if present, else returns the command sequence.
shading_model: declare the scene's operable shading -- 'none' (no device modelled),
'modelled' (a device is in the geometry) or 'lm83_default_blind'. The returned sDA_basis
block records it alongside the analysis period and says whether the sDA key is an LM-83
sDA or only the underlying DA-based spatial fraction. Left undeclared it reports
'undeclared' and lm83_conformant: false -- the metric is never assumed conformant.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run | No | ||
| wea | Yes | ||
| points | No | ||
| quality | No | ||
| udi_aut | No | ||
| udi_sup | No | ||
| work_dir | No | ||
| ase_hours | No | ||
| occupancy | No | ||
| udi_lower | No | ||
| rad_params | No | ||
| sensor_set | No | ||
| channel_type | No | ||
| da_threshold | No | ||
| occupied_end | No | ||
| timestep_min | No | ||
| ase_threshold | No | ||
| shading_model | No | ||
| channel_scenes | Yes | ||
| occupied_start | No | ||
| sda_da_fraction | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||