daylight_savings
Simulate daylight at reference points to compute automated lighting control savings, supporting point-in-time and annual modes, with optional plan preview without execution.
Instructions
Automated daylight-responsive savings: daylight sim at the reference points -> lighting_controls.
mode='point_in_time' uses run_grid (scene_sets + points; supports multiple reference points); mode='annual' uses run_annual_daylight (channel_scenes + wea + points, 8760 h) and supports a multi-point grid (one weight per reference point) via points=[...] or sensor_set='name'. run=False emits the command plan without executing. An annual run elicits confirmation first (it is long); decline -> the emitted plan is returned.
weights: one per reference point, interpreted as that daylight zone's FLOOR-AREA FRACTION, so they must sum to <= 1.0 (NOT one-per-zone full-power flags -- e.g. [1, 1] is invalid; use [0.4, 0.3] etc.). The leftover (1 - Σweights) is the uncontrolled core area billed at full power. For a single point pass [1.0]. Compute proper fractions with hcl_core.lighting_controls.area_weights_from_geometry(width, length, window_head, task_height).
Return shapes: {"ran": False, ...commands...} (not executed); {"ran": True, "error": ..., "failed_step": ...} (a Radiance step failed mid-run); else {"ran": True, "mode": ..., "controls": ...} on success.
Note: in annual mode with schedule=None, the default weekday 08:00-18:00 mask is built to the
length run_annual returns and assumes an 8760-h, Monday-anchored (HOY 0 = Mon 00:00) series. If
run_annual is run over a sub-period or a non-Monday-anchored year, pass an explicit schedule.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run | No | ||
| wea | No | ||
| area | No | ||
| iset | No | ||
| mode | No | point_in_time | |
| fL_min | No | ||
| fP_min | No | ||
| points | No | ||
| n_steps | No | ||
| p_rated | No | ||
| quality | No | ||
| weights | No | ||
| schedule | No | ||
| work_dir | No | ||
| rad_params | No | ||
| scene_sets | No | ||
| sensor_set | No | ||
| channel_type | No | ||
| control_type | No | ContinuousOff | |
| channel_scenes | No | ||
| workbook_compat | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||