Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Build, Test, and Push Docker Image
on:
push:
branches: [ "master" ]
tags: [ 'v*.*.*' ] # Trigger on semver tags
tags: [ 'v*.*.*' ]
pull_request:
branches: [ "master" ]
workflow_dispatch:
Expand Down Expand Up @@ -38,7 +38,10 @@ jobs:
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
# For git tags like v1.2.3, create a Docker tag 1.2.3
type=semver,pattern={{version}}
# For all other events (pushes to master, PRs)
type=sha,prefix=,format=short

- name: Build and push Docker image
id: build-and-push
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
push:
branches:
- "master"
- "dev"
# - "dev"
pull_request:
branches: [ "master" ]
workflow_dispatch:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guide/core_concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Simulation Workflow Summary
* Commands from a script file (or interactive input) are processed.
* :doc:`Parameters </reference/parameters>` are set.
* The :ref:`FireDomain <cmd-firedomain>` is created.
* :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.
* :ref:`loadData <cmd-loaddata>` populates the `DataBroker` with `DataLayer` from the :doc:`/user_guide/landscape_file`. The :doc:`/user_guide/fuels_and_models` information is associated.
* 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`.

2. **Simulation Loop (driven by step or goTo):**
Expand Down
151 changes: 0 additions & 151 deletions docs/source/user_guide/fuels_file.rst

This file was deleted.

8 changes: 4 additions & 4 deletions docs/source/user_guide/landscape_file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ At a minimum, a functional ForeFire simulation generally requires the following

* **Typical Variable Name(s):** ``fuel``, ``fuel_index``, ``land_cover`` (The exact name might be configurable or expected by default - check standard examples or parameters).
* **Description:** A 2D array (grid) containing **integer values** representing the fuel type at each location in the simulation domain.
* **Crucial Link:** Each unique integer value in this array **must** correspond directly to an ``Index`` value present in the :doc:`fuels_file` used for the simulation. ForeFire uses this to look up the fuel properties needed for the fire spread calculations. Index `0` is often used for non-burnable areas.
* **Crucial Link:** Each unique integer value in this array **must** correspond directly to an ``Index`` value present in the model parameter file (see :doc:`/user_guide/fuels_and_models`) used for the simulation. ForeFire uses this to look up the fuel properties needed for the fire spread calculations. Index `0` is often used for non-burnable areas.
* **Dimensions:** Typically (Y, X) or (latitude, longitude) corresponding to the spatial grid.

* **Elevation (Digital Elevation Model - DEM)**
Expand Down Expand Up @@ -58,10 +58,10 @@ Coordinate System & Domain Definition
* **Grid:** All 2D spatial variables (Fuel, Elevation, Wind) within the file must share the **same grid resolution, spatial extent, and coordinate system**.
* **Domain Bounds:** The simulation domain is defined when creating the :ref:`FireDomain <cmd-FireDomain>`. You specify the South-West (SW) and North-East (NE) corners in the *projected Cartesian coordinates* (meters). Optionally, you can also provide the WGS84 geographic bounding box (`opt:BBoxWSEN` in `FireDomain`), which helps ForeFire align the simulation coordinate system with real-world locations, especially for outputs like GeoJSON or KML.

Relationship to Fuels File
--------------------------
Relationship to the Fuels & Models File
---------------------------------------

As mentioned under Required Variables, the link between the integer values in the ``fuel`` layer of the NetCDF file and the ``Index`` column in the :doc:`fuels_file` is **absolutely critical**. If the landscape file contains a fuel index (e.g., `5`) that is not defined in the ``fuels.csv``, the simulation will likely fail or produce incorrect results.
As mentioned under Required Variables, the link between the integer values in the ``fuel`` layer of the NetCDF file and the ``Index`` column in the model parameter file (see :doc:`/user_guide/fuels_and_models`) is **absolutely critical**. If the landscape file contains a fuel index (e.g., `5`) that is not defined in the ``fuels.csv``, the simulation will likely fail or produce incorrect results.

Creating Landscape Files
------------------------
Expand Down
Loading