nz-solar-potential

Agent instructions for nz-solar-potential

Verified facts and rules for AI-assisted work on this repo. Code wins where it disagrees with this file. Update this file in the same change that alters a fact, rule or workflow.

Keeping this file

Architecture

A Python geospatial pipeline (LINZ outlines, LiDAR, imagery → per-building solar estimates and panel layouts) and a static MapLibre map. Module boundaries: docs/developers/architecture.md. Entry points, delegation, machine boundaries and run ownership: docs/developers/tooling-execution.md. tools/pipeline.py is not yet a common front door for all operations: local pipeline, district and worker builds maintain separate stage sequences. Document current behaviour separately from the consolidation target. Doc map: docs/index.md. Write for the persona named there. Keep each procedure or detailed explanation in one primary guide and link from summaries; repeat safety warnings where a reader is about to act. Keep Markdown guides in persona subdirectories matching the index, with point-in-time notes under docs/ai-agents/archive/. When code is removed, remove its obsolete documentation and diagram paths in the same change; consolidate redundant explanations rather than preserving them as history.

Build and test

Setup: docs/data-maintainers/local-setup.md.

Conventions

Every number shows its workings

Every figure on the map must be traceable and must agree with every other figure for the same thing. Code enforces this:

Operating rules

Verified facts

Pipeline

Data, CRS and storage

Geometry, sunlight and front end

Last checked against the code: 2026-10-28.

The national candidate-area snapshot is maintained in Areas, regenerated by tools/list_areas.py from LINZ locality attributes using the pipeline’s region-id helpers. It excludes lakes and inland bays, matching tools/find_area.py defaults; it does not certify building presence or survey coverage.

Open questions