How to run the local quickstart
Build the default area on your computer and open it on a local map.
The default area is queenstown-lakes-district/queenstown/sunshine-bay
(about 250 buildings), set by CLOUD_SHARED_BUILD["local_region"] in
config.py.
Before you start
- macOS, Ubuntu, or Windows with WSL.
- About 10 GB of free disk.
- A LINZ Data Service API key.
Steps
-
Get the code:
git clone https://github.com/rewiring-nz/nz-solar-potential.git cd nz-solar-potential -
Install the tools, Python environment and LINZ key with Local setup. Continue when its environment check prints
ready. This is the only API key needed; the web pipeline's optional locality grid uses the LINZ boundary and needs no extra dataset or key. -
Run the pipeline:
bash quickstart.shAnswer the paid-referee question. Enter declines it, which costs nothing.
This run replaces the combined map data in
data/with this area. -
Open the map. The browser opens automatically; otherwise open the
Map preview:URL printed at the end. -
Read the report printed as
Pipeline report:(data/pipeline_runs/<run-id>/report.md). Every step should bePASSorSKIPPED. ADEGRADEDstep means part of the result is missing. Read its effect before you trust the map. -
Stop the preview server when finished:
kill "$(cat data/pipeline_runs/<run-id>/map-preview-server.pid)"
If a step fails, find its number in Troubleshooting.
Next steps
- Preserve the inspected region with Push to staging in the Build data panel. This copies its built output into a frozen, checksummed local copy without rebuilding or publishing; it does not deploy or change the map. In Local releases, select staged versions, assemble and preview a candidate, compare it with the local deployment, then approve and activate it. Unselected deployed regions are preserved. Configure retention explicitly before activation; rollback and grace-period cleanup are available without cloud calls or another build.
- Build another region.
- Run the quickstart in the cloud for a shareable preview.
- Build several regions.
- Look up run options in the pipeline run options reference.