From 4e2657bdc8add7bd1c7991fe5ed1739302dfa3b3 Mon Sep 17 00:00:00 2001 From: Antonio Leblanc Date: Tue, 27 Oct 2026 15:54:56 -0300 Subject: [PATCH] docs: fix command examples that fail or are silently ignored Every corrected example was run against a build of dev. - Comments: a '#' after a command is read as a schedule operator, the command does not run ("unknown post operator"). Moved trailing comments to their own line and documented the rule. - FireDomain: only sw, ne and t are read. BBoxWSEN and date= were ignored, leaving the domain georeferenced at DefaultSWLngLat (Corsica). Document setParameter[BBoxWSEN=...] before FireDomain. - startFire: lonlat needs three values (lon,lat,z); (lon,lat) starts no fire. - trigger: the form is trigger[wind;vel=(...)]@t=..., not fuelType=wind; t= inside the brackets is not read. - plot: opt: is notation, not syntax; there is no area= key (BBoxWSEN, BBoxLBRT, BBoxLBRT=active); size takes no parentheses; the arrival time parameter is arrival_time. The in-app help (app/forefire/commands.md) gets the same fixes. --- app/forefire/commands.md | 48 +++++------ docs/source/reference/commands.rst | 88 ++++++++++++--------- docs/source/user_guide/forefire_script.rst | 30 +++---- docs/source/user_guide/fuels_and_models.rst | 3 +- docs/source/user_guide/landscape_file.rst | 2 +- 5 files changed, 96 insertions(+), 75 deletions(-) diff --git a/app/forefire/commands.md b/app/forefire/commands.md index 3cf6d191..3394b5e2 100644 --- a/app/forefire/commands.md +++ b/app/forefire/commands.md @@ -1,13 +1,15 @@ std::string commandHelp = R"( ## FireDomain - FireDomain[sw=(x,y,z);ne=(x,y,z);t=seconds|date=YYYY-MM-DDTHH:MM:SSZ;opt:BBoxWSEN=(8.36215875,41.711125,9.1366311,42.28667)] + FireDomain[sw=(x,y,z);ne=(x,y,z);t=seconds] Create the main FireDomain; fronts and nodes will be created within this FireDomain - Example: FireDomain[sw=(0,0,0);ne=(64000,64000,0);BBoxWSEN=(lonWest,latSouth,lonEast,latNorth);t=2400] + Example: FireDomain[sw=(0,0,0);ne=(64000,64000,0);t=2400] Arguments: - 'sw': Southwest point (x,y,z) in meters - 'ne': Northeast point (x,y,z) in meters - - 't': Time associated with the fire domain in seconds or as an absolute ISO GMT date - - 'opt:BBoxWSEN': Optional WGS coordinates for the north-oriented bounding box (lonWest,latSouth,lonEast,latNorth) + - 't': Time associated with the fire domain in seconds (no 'date=' here) + To georeference the domain, set BBoxWSEN before creating it, e.g. + setParameter[BBoxWSEN=8.36215875,41.711125,9.1366311,42.28667] + FireDomain does not read BBoxWSEN; without the parameter the domain is placed at DefaultSWLngLat (Corsica) ## FireFront @@ -45,12 +47,12 @@ std::string commandHelp = R"( - 'nowplus': Delta duration in seconds for the scheduled command to execute; ## startFire - startFire[loc=(x,y,z)|lonlat=(lon,lat);t=seconds|date=YYYY-MM-DDTHH:MM:SSZ] + startFire[loc=(x,y,z)|lonlat=(lon,lat,z);t=seconds|date=YYYY-MM-DDTHH:MM:SSZ] Creates the smallest possible triangular fire front at the specified location and time - Example: startFire[loc=(0.0,0.0,0.0),t=0.] + Example: startFire[loc=(0.0,0.0,0.0);t=0.] Arguments: - 'loc': Starting location of the fire (coordinates x,y,z) - - 'lonlat': WGS coordinates of the ignition point + - 'lonlat': WGS coordinates of the ignition point (lon,lat,z); all three values are required - 't': Time when the fire is started (in seconds or as an absolute ISO GMT date); ## step @@ -67,15 +69,15 @@ std::string commandHelp = R"( ## trigger - trigger[fuelIndice=;loc=(x,y,z);fuelType=;vel=(vx,vy,vz);t=