README: what flooded does today, to soul's readme.md (#81)

[NewGraphEnvironment]

Summary

• README rewritten to soul conventions/readme.md: what flooded maps and what each resolution shows, how the Valley Confinement Algorithm works and where it comes from, what a run needs and where those inputs come from, a Parsnip figure built by data-raw/readme_figure.R, a bundled-reach example with its real output, and Learn more, Ecosystem, Data and methods, Citation and License sections.
• After the review rounds the README was revised with the operator: plainer and less hedged, a How it works and a What it needs section, inputs traced to their sources (MRDEM-30, stac-elevation-bc, stac-pointcloud-bc, fwapg, ClimateBC), floodplains and stac-floodplains-bc in Learn more, and an ecosystem table linked to each package's site (diggs and breaks out; wet and stac_floodplains_bc in).
• DESCRIPTION's Title and Description follow the tagline and opening. New Graph Environment Ltd. is cph and fnd, now that LICENSE on main names it; the citation workflow passes authors_roles = c("aut", "cre", "fnd"), so CITATION.cff lists Allan Irvine and NGE Ltd.
• inst/NOTICE.md gives the licence of every redistributed dataset. LICENSE.note now ships in the tarball.
• The pkgdown reference index is grouped by purpose.
• The stale threads timing is re-measured on the Parsnip grid: threads 1 and 8 overlapped under load, so no threads effect is claimed.

Related Issues

• Fixes README: add DEM fetch, flood-factor scenarios, per-watercourse attribution and the Parsnip vignette #81
• Relates to Parsnip vignette data ships Digital Road Atlas roads, which the BC catalogue lists as Access Only #85: the Digital Road Atlas layer is Access Only, and the TRIM DEM and ClimateBC licences are unconfirmed. Found while writing NOTICE.
• Relates to Build the bundled and vignette data from our link-built tables, not bcfishpass #87: move the bundled data to our own link-built tables.
• Relates to NewGraphEnvironment/soul#426: the convention's cph roles would list third-party copyright holders as citation authors.

Test plan

• devtools::check(--no-manual): 0 errors, 0 warnings. The 2 NOTEs predate this branch (CITATION.cff and pkgdown/ at top level).

• Tests, examples and vignette rebuild pass. lintr flags nothing in changed lines.

• pkgdown::check_pkgdown() and build_site(): the figure is served and the six reference sections render.

• The README example re-runs under load_all() and matches its pasted output. Every README link resolves, except the inst/NOTICE.md link, which resolves after merge.

• /code-check branch, three rounds:

  • Round 1: 62 claims, 8 findings.
  • Round 2: 64 claims, 6 findings, 4 of them inside round 1's fixes.
  • Round 3: a 92-claim enumeration, 2 low findings.

  All fixed.

Notes

• At merge: set the GitHub About text to the new tagline: gh repo edit NewGraphEnvironment/flooded --description "Map floodplains from an elevation model and a stream network". It was held back because it goes public immediately.
• LICENSE on main now names New Graph Environment Ltd., so it is cph as well as fnd (merged in before release).
• README length: 406 to 600 prose words, against a 450-500 forecast. The required sections add about 300 words. The breakdown is in the archive README.
• The planning record and measurements are in planning/archive/2026-10-issue-81-readme-refresh/.

🤖 Generated with Claude Code

https://claude.ai/code/session_0186ZefY3qMPiW8pwnwwMuxW