nz-solar-potential

Documentation

Docs for nz-solar-potential, the NZ rooftop solar map. Choose your role below. Start with a how-to when doing a task; use a reference when you need the exact stages, files or implementation.

Map users

Document What it covers
Using the web map Find a building and read its estimate.

Data maintainers

Start here. Each how-to is a short set of steps ending in “Next steps”.

How-to What it covers
Run the local quickstart Build the default area on your computer and open the map.
Run the cloud quickstart Build the default area on the shared VM and open a developer preview.
Build a region Find, check and build another area, locally or on the shared VM.
Build several regions Build multiple regions and view them on one map: locally, on the shared VM or on a fleet.
Build data in the web interface Check area data, choose work on a map, see an estimate (with cloud cost), and follow local, developer-preview or published builds.
Pipeline run options Reference: every way to run the pipeline, its options, environment variables and cost prompts.

Background and detail:

Document What it covers
Quickstart Run the pipeline on one region and open the map.
Choosing an area Find a LINZ suburb or locality and its region id.
Areas Browse the national candidate-area catalogue by council, with exact region ids.
Cloud quickstart Shared-VM developer previews and experimental developer-VM profiles, costs and clean-up.
Local setup Install tools, create the Python environment and configure LINZ credentials.
Pipeline reference Interpret local/profile pipeline stages, outputs and statuses; stop previews and clean up safely.
Dataset operations Prepare, build, review, publish and roll back a district dataset.
Team access Get shared-project permissions; administer preview hosting.
Troubleshooting Fix pipeline, fetch, map-build and preview errors.

Developers

Document What it covers
Architecture Understand data flow and module responsibilities.
Tooling and execution Trace commands across machines; compare build engines and the proposed common interface.
Static site and documentation Render and publish the same documentation on GitHub Pages, local servers and developer previews.
Reviewer’s guide Check geometry rules, inspect changes and choose validation tools.

Researchers

Document What it covers
How a roof estimate is made Start here for a plain-English walkthrough.
Economics Inspect the bill model, financial assumptions and battery scenarios.
Theory Assess evidence, modelling choices, accuracy limits and missing validation.

Maintainers

Document What it covers
Scaling and iteration Plan national capacity from historical measurements and identify what still needs measuring.
Scale architecture Understand regional assembly, input retention and fleet coordination.
ADR 0001 Containerisation decision.

AI agents

Document What it covers
AGENTS.md Facts and rules for AI-assisted work.
handover 24 Sep, bug notes 22 Aug, national rehearsal plan Archived point-in-time notes (may be out of date)