From 96af2c681bc116bcf2582299abb5cf9a0ba41d17 Mon Sep 17 00:00:00 2001 From: amarcozzi Date: Wed, 26 Aug 2026 16:50:20 -0600 Subject: [PATCH] Document seasonal FBFM40 in the creating-grids guide Add a "Seasonal fuels" how-to section covering the new season argument (ES/SP/SU/FA with a seasonal version) and note that represented_year is the projected season year. Also correct the annual-version example, which listed "2025" as a pinnable vintage -- 2025 is seasonal-only and is rejected without a season. --- docs/v2/guides/creating-grids.md | 35 +++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/docs/v2/guides/creating-grids.md b/docs/v2/guides/creating-grids.md index 55748da..b182506 100644 --- a/docs/v2/guides/creating-grids.md +++ b/docs/v2/guides/creating-grids.md @@ -120,9 +120,9 @@ grid = ff.grids.create_fuel_model_grid_from_landfire_fbfm40( ) ``` -To pin a LANDFIRE vintage, pass `version` (`"2024"` or `"2025"`); it defaults -to the API's current version. A completed grid reports the calendar year its -fuels represent on `grid.represented_year`: +To pin an annual LANDFIRE vintage, pass `version` (e.g. `"2024"`); it defaults +to the API's current version. The grid reports the calendar year its fuels +represent on `grid.represented_year`: ```python grid = ff.grids.create_fuel_model_grid_from_landfire_fbfm40( @@ -135,6 +135,35 @@ grid = ff.grids.create_fuel_model_grid_from_landfire_fbfm40( 2024 ``` +### Seasonal fuels + +LANDFIRE Seasonal Fuels adjusts FBFM40 for a time of year — early spring +(`"ES"`), spring (`"SP"`), summer (`"SU"`), or fall (`"FA"`). Pass `season` +together with a seasonal `version` (`"2025"`) to fetch it on demand from the +LANDFIRE Product Service instead of the staged annual release: + +```python +grid = ff.grids.create_fuel_model_grid_from_landfire_fbfm40( + domain, version="2025", season="SP", output_resolution_m=30 +) +``` + +`grid.represented_year` is the projected season year — version `"2025"` plus +`"SP"` is spring 2026: + +```python +>>> grid.represented_year +2026 +``` + +!!! warning "Seasonal coverage is limited" + + Seasonal Fuels covers a changing region rather than all of CONUS. A + request for a domain outside the current coverage raises + `UnprocessableEntityException`. See + [LANDFIRE Seasonal Fuels](https://landfire.gov/fuel/seasonal_fuels) for + current availability. + ### Look up fuel parameters from FBFM40 codes The `fbfm` band holds codes, not the quantities a fire model consumes. To