nz-solar-potential

How to build a region

Build an area other than the quickstart default, either on your computer or on the shared build VM.

Before you start

1. Find the region id

.venv/bin/python tools/find_area.py arrowtown

Copy the region id for the area you want. It has the form <council>/<town>/<suburb>, for example queenstown-lakes-district/arrowtown/arrowtown.

2. Check it can be built

.venv/bin/python tools/find_area.py arrowtown --details

Check these values:

Choosing an area covers duplicate names, areas with no town and areas that cross council boundaries.

3a. Build it locally

bash quickstart.sh queenstown-lakes-district/arrowtown/arrowtown

The first build in a council downloads its LINZ building outlines once, which can take a few minutes. The combined map in data/ then shows only this region. Other built regions remain under data/out/.

3b. Or build it on the shared VM

bash quickstart.sh --mode cloud queenstown-lakes-district/arrowtown/arrowtown

Approve the cost and paid-referee questions as in the cloud quickstart. The VM fetches the region’s inputs before it builds them. Inputs that are already on the VM are reused.

4. Check the result

Next steps