Build the rooftop solar data for one area and view it on a local map. For a shared-VM build and public developer preview, use the cloud quickstart instead.
cd ~
git clone https://github.com/rewiring-nz/nz-solar-potential.git
cd nz-solar-potential
Follow Local setup for your system tools,
Python environment and LINZ key. Return here when the environment check
prints ready and credentials are configured.
The LINZ key is the only API key needed. The web pipeline’s optional grid
selection uses the LINZ locality boundary and needs no extra dataset or key.
This replaces the current combined map data in data/ with the selected
region. Use a small region locally; district builds belong on the build VM.
bash quickstart.sh
This builds the default area,
queenstown-lakes-district/queenstown/sunshine-bay (about 250 buildings,
CLOUD_SHARED_BUILD["local_region"] in config.py), on your computer. Its
outputs go under data/regions/queenstown-lakes-district/queenstown/sunshine-bay/
and data/out/queenstown-lakes-district/queenstown/sunshine-bay/. To build
another area, pass its LINZ suburb or locality id <council>/<town>/<suburb>:
.venv/bin/python tools/find_area.py arrowtown # prints the region id
bash quickstart.sh queenstown-lakes-district/arrowtown/arrowtown
Choosing an area explains where the ids come from
and how to check an area’s size and LiDAR coverage. The first build in a
council downloads that council’s LINZ building outlines once as a GeoPackage
(Queenstown-Lakes District: about 16 MB, a few minutes in the LINZ export
queue). Older bounding-box regions in REGIONS in config.py (such as
town_gorge_north) still build by name, with a deprecation warning.
The local queue starts one worker process without cloud access. For
multi-worker debugging and persistent task status, see
Local task queue.
Extra workers do not split a single region or speed up builds sharing one checkout.
To pick areas on a map and follow builds in the browser instead, use the web pipeline panel.
data/pipeline_runs/<run-id>/report.md.