Fix fuel moisture examples to use percent instead of fractions - #187
Merged
Conversation
Fuel moisture is percent at the API/grid/SDK-input level; the QUIC-Fire exporter divides by 100 to produce the fraction treesmoist.dat expects. Several docstrings and the export_to_quicfire tutorial showed fractions (0.08, 0.15, ...), which store 100x too little moisture. Replace the fraction values with their percent equivalents and correct the accompanying "(0.0-1.0)" comments to "(%)". Closes #186
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Fuel moisture is percent everywhere a user supplies it. The QUIC-Fire exporter divides by 100 (
fmc_array /= 100) before writingtreesmoist.dat, so a value of0.08stores0.08%and ends up as0.0008— near-zero moisture. Several docstrings and the export tutorial showed fractions, so users copying them got moisture 100× too low.Changes
docs/v1/tutorials/export_to_quicfire.md:0.15 → 15.0,0.05 → 5(5%),0.15 → 15,0.08 → 8(8%),0.12 → 12; comment(0.0-1.0) → (%).fastfuels_sdk/v1/convenience.py:export_roidefault surface config0.15 → 15, "5%" example0.05 → 5; comment(0.0-1.0) → (%).fastfuels_sdk/v1/grids/grids.py:create_surface_griddocstring example0.1 → 15.0.Docs-only; no runtime behavior changes. The pipeline was already correct — builder methods,
guides/grids.md, and tree-grid examples already used percent and are untouched.Reported by
A collaborator setting "8%" surface moisture followed the docs, sent
0.08, and saw0.08%in their QUIC-Fire inputs; sending8produced the correct result.Closes #186