Skip to content

Commit aef5a74

Browse files
fix ` in docs
1 parent 945a1ad commit aef5a74

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/source/reference/commands.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Creates the smallest possible triangular fire front (an ignition point) at the s
135135
**Arguments:**
136136

137137
* ``loc=(x,y,z)``: Starting location using Cartesian coordinates (x,y,z) in meters.
138-
* ``lonlat=(lon,lat)``: Starting location using WGS84 coordinates (longitude, latitude). *Use either ``loc`` or ``lonlat``.*
138+
* ``lonlat=(lon,lat)``: Starting location using WGS84 coordinates (longitude, latitude). *Use either loc or lonlat.*
139139
* ``t=seconds|date=YYYY-MM-DDTHH:MM:SSZ``: Time when the fire is started, either in seconds since simulation start or as an absolute ISO 8601 GMT date/time.
140140

141141
**Example:**
@@ -344,7 +344,7 @@ Triggers a change in simulation data at a specific time and location. Can be use
344344
345345
Prints a representation of the current simulation state (primarily the fire front location) to the console or to a specified file. The output format is determined by the `dumpMode` parameter (set via `setParameter`).
346346

347-
**Output Formats (`dumpMode`):**
347+
**Output Formats (dumpMode):**
348348

349349
* `ff`: Native format, potentially re-parsable by ForeFire.
350350
* `json`: Compact Cartesian JSON format.

docs/source/user_guide/basic_configuration.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ Basic Configuration
33

44
ForeFire simulations typically require three main input files to run:
55

6-
1. **Fuels File (`.csv`)**: Defines the classes of fuels and their associated parameters used by the fire spread model (e.g., Rothermel).
7-
2. **Landscape File (`.nc`)**: A NetCDF file containing geospatial data layers for the simulation domain, typically including:
6+
1. **Fuels File (.csv)**: Defines the classes of fuels and their associated parameters used by the fire spread model (e.g., Rothermel).
7+
2. **Landscape File (.nc)**: A NetCDF file containing geospatial data layers for the simulation domain, typically including:
88

99
- Elevation (Digital Elevation Model - DEM)
1010
- Fuel types map (matching the indices in the Fuels File)
1111
- (Optionally) Pre-defined wind fields or other environmental data.
12-
3. **ForeFire Script File (`.ff`)**: A text file containing commands and parameters that control the simulation execution. This includes:
12+
3. **ForeFire Script File (.ff)**: A text file containing commands and parameters that control the simulation execution. This includes:
1313

1414
- Setting simulation parameters (e.g., propagation model, output format).
1515
- Loading the landscape and fuels data.

docs/source/user_guide/core_concepts.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ Key Simulation Components
2020

2121
The simulation engine relies on several key C++ components (classes) to manage the fire spread process:
2222

23-
* **`Simulator` & `TimeTable` (Event-Driven Core)**
23+
* **Simulator & TimeTable (Event-Driven Core)**
2424

2525
* ForeFire uses an **event-driven** approach. Instead of fixed time steps for the entire simulation, it maintains a `TimeTable` (a prioritized queue) of future events.
2626
* Each event typically corresponds to a `FireNode` needing an update at a specific future time.
2727
* The `Simulator` processes events from the `TimeTable` in chronological order. It retrieves the next event, tells the associated object (like a `FireNode`) to update its state and calculate its next move, and then the object schedules its *next* update event back into the `TimeTable`.
2828
* **This event-driven approach means the simulation doesn't use fixed global time steps; different parts of the front can advance according to their own calculated timings.**
2929

30-
* **`FireDomain` (The Simulation World)**
30+
* **FireDomain (The Simulation World)**
3131

3232
* Represents the overall simulation area and context.
3333
* Manages the simulation's current time.
@@ -37,7 +37,7 @@ The simulation engine relies on several key C++ components (classes) to manage t
3737
* Manages the `TimeTable` of simulation events.
3838
* May handle discretization of the domain into cells (e.g., for flux calculations or burning map outputs).
3939

40-
* **`FireFront` & `FireNode` (Representing the Fire)**
40+
* **FireFront & FireNode (Representing the Fire)**
4141

4242
* ForeFire uses a **Lagrangian** approach to track the fire's edge.
4343
* A `FireFront` represents a continuous segment of the fire perimeter. It is essentially a linked list of `FireNode` objects.
@@ -55,7 +55,7 @@ The simulation engine relies on several key C++ components (classes) to manage t
5555
* **Splitting:** Not explicitly mentioned in summary, but might occur if front self-intersects or hits complex boundaries.
5656
* **Inner Fronts:** `FireFront` s can be nested to represent unburned islands within the main fire perimeter.
5757

58-
* **`DataBroker` & `DataLayer` (Accessing Environmental Data)**
58+
* **DataBroker & DataLayer (Accessing Environmental Data)**
5959

6060
* The `DataBroker` is the central hub for all environmental data needed by the simulation (terrain, fuel, weather).
6161
* It manages a collection of `DataLayer` objects. Each `DataLayer` provides access to a specific type of data (e.g., elevation, fuel index, wind speed).
@@ -69,13 +69,13 @@ The simulation engine relies on several key C++ components (classes) to manage t
6969
* Interpolating data in space and potentially time (e.g., for time-varying wind fields).
7070
* When a `FireNode` needs environmental data to calculate its speed, it asks the `DataBroker`, which efficiently retrieves the necessary values from the relevant `DataLayer` (s) at the node's location.
7171

72-
* **`PropagationModel` & `FluxModel` (The Physics)**
72+
* **PropagationModel & FluxModel (The Physics)**
7373

7474
* ForeFire uses a **Strategy pattern** for physical calculations, allowing different models to be plugged in.
7575
* `PropagationModel` subclasses (e.g., `Rothermel`, `Balbi`, `Iso`) implement specific algorithms to calculate the Rate of Spread (ROS) based on properties fetched via the `DataBroker`. The active model is chosen using the :ref:`propagationModel <param-propagationmodel>` parameter.
7676
* `FluxModel` subclasses (e.g., `HeatFluxBasicModel`) calculate fluxes (like heat, water vapor) from the burning area, often needed for coupled simulations or specific research outputs.
7777

78-
* **`SimulationParameters` (Configuration)**
78+
* **SimulationParameters (Configuration)**
7979

8080
* A central place (likely a Singleton class internally) holding the global configuration values set by the user via :ref:`setParameter <cmd-setparameter>` or :ref:`setParameters <cmd-setparameters>` commands. This includes things like model choices, resolution parameters, output settings, etc.
8181

@@ -88,10 +88,10 @@ Simulation Workflow Summary
8888
* Commands from a script file (or interactive input) are processed.
8989
* :doc:`Parameters </reference/parameters>` are set.
9090
* The :ref:`FireDomain <cmd-firedomain>` is created.
91-
* :ref:`loadData <cmd-loaddata>` populates the `DataBroker` with `DataLayer`s from the :doc:`/user_guide/landscape_file`. The :doc:`/user_guide/fuels_file` information is associated.
91+
* :ref:`loadData <cmd-loaddata>` populates the `DataBroker` with `DataLayer` from the :doc:`/user_guide/landscape_file`. The :doc:`/user_guide/fuels_file` information is associated.
9292
* The initial fire state is defined using :ref:`startFire <cmd-startfire>` or custom `FireFront`/`FireNode` commands, scheduling the first update events for the initial nodes into the `TimeTable`.
9393

94-
2. **Simulation Loop (driven by `step` or `goTo`):**
94+
2. **Simulation Loop (driven by step or goTo):**
9595

9696
* The `Simulator` gets the chronologically next event (usually a `FireNode` update) from the `TimeTable`.
9797
* The `Simulator` advances the global simulation time to the event time.

0 commit comments

Comments
 (0)