Skip to content

Commit 66ead07

Browse files
committed
plugin guide: the output path is a stem for a family of files
The dialog takes one .tif path, but an ensemble run writes seven files beside it: the likelihood bands, the existing fabric, the raw pre-processing state, the two clustering options, the report and the parameter sidecar. The guide now names them, so the bundle does not surprise a first-time user.
1 parent da4c196 commit 66ead07

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

website/src/pages/plugin.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ The fastest route uses the OSM downloader for the data and accepts most defaults
4141
4. Open **Isobenefit Urbanism**. The dialog pre-fills its layer pickers from the OSM download,
4242
suggests a local projected CRS, and validates as you type; the status line under the form
4343
lists what is still missing.
44-
5. Set an **output file** (a `.tif` path). This is usually the only required field left.
44+
5. Set an **output file** (a `.tif` path). This is usually the only required field left. The
45+
path acts as a stem: an ensemble run writes a family of files beside it, all sharing the
46+
name (the plan options, the report and the parameter sidecar).
4547
6. Set the **target population**: the number of new residents to house. Existing buildings are
4648
context only and are never counted.
4749
7. Check the **Development density** group: three densities (people per km²) and the share of
@@ -134,7 +136,8 @@ the three densities; post-processing arranges the highest nearest the mixed-use
134136

135137
**Output.** *Development likelihood* (the default) blends many runs; the *Detail* picker sets how
136138
many (Quick 10 / Standard 50 / Thorough 100). Untick it for a single run written as a growth
137-
animation. The output file must be a `.tif`; the CRS must be a local projected CRS (a suggestion
139+
animation. The output `.tif` path is the stem for the run's whole output family (see Outputs
140+
below); the CRS must be a local projected CRS (a suggestion
138141
is made from the extents layer; geographic lat/lon CRSs are rejected so the model always works in
139142
metres).
140143

@@ -149,11 +152,13 @@ missing.
149152

150153
## Outputs and how to read them
151154

152-
**Ensemble mode** loads, top to bottom: existing development; the raw chosen run (before
153-
post-processing); the moderately and tightly clustered scenario options (each coloured by
154-
density tier: built as a yellow-to-brown ramp, mixed-use centres as a reds ramp, existing fabric
155-
muted); and the built/green likelihood bands. A `_report.txt` records the parameters and
156-
per-option statistics.
155+
**Ensemble mode** writes a family of files sharing the chosen output name: `<name>.tif` (the
156+
built and green likelihood bands), `<name>_existing.tif` (the starting fabric),
157+
`<name>_pre.tif` (the chosen run before post-processing), `<name>_moderate.tif` and
158+
`<name>_tight.tif` (the two clustering options, each coloured by density tier: built as a
159+
yellow-to-brown ramp, mixed-use centres as a reds ramp, existing fabric muted),
160+
`<name>_report.txt` (parameters and per-option statistics) and `<name>_params.json` (the
161+
reloadable settings). QGIS loads them as a layer group in that order.
157162

158163
Every population figure counts **new residents only**; existing fabric is assumed served by its
159164
own centres. The per-person readouts follow: m² of mixed-use centre per person is new centre

0 commit comments

Comments
 (0)