Skip to content

Document the NumPy array path — no NetCDF, no GIS - #189

Merged
antonio-leblanc merged 1 commit into
devfrom
doc/numpy-case-page
Aug 13, 2026
Merged

Document the NumPy array path — no NetCDF, no GIS#189
antonio-leblanc merged 1 commit into
devfrom
doc/numpy-case-page

Conversation

@HugoFara

Copy link
Copy Markdown
Collaborator

Closes#168.

A new User Guide page showing how to drive a complete simulation from NumPy
arrays via addIndexLayer/addScalarLayer — a fuel map and a wind field in
memory, no landscape .nc and no GIS. This is the on-ramp for the pip + numpy
audience, and it was previously only discoverable as an unreferenced script in
tests/.

The worked example was run end-to-end against a pip-installed ForeFire, so the
call sequence in the docs is verified, not illustrative.

  • docs/source/user_guide/python_arrays.rst — the new page (numpy in, numpy
    out via helpers.printToPathe, plus how the fuel table changes per model).
  • Linked from the User Guide toctree and the README's Python snippet.

Docs only; no code changes. Leaves landscape_file.rst untouched to avoid
colliding with #179.


Generated by Claude Opus 4.8, and reviewed manually before posting.

Add a User Guide page walking through a complete simulation driven entirely
from NumPy arrays via addIndexLayer/addScalarLayer, with no landscape .nc and
no GIS. The worked example was verified against a pip-installed ForeFire.
Link it from the index toctree and from the README's Python snippet.
Closes#168

@antonio-leblancantonio-leblanc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs okay

@antonio-leblanc
antonio-leblanc merged commit f872d43 into devAug 13, 2026
4 checks passed
@antonio-leblanc
antonio-leblanc deleted the doc/numpy-case-page branch August 13, 2026 20:26
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@HugoFara@antonio-leblanc