From 235d85d78d2a7f138dba55d9934f0cf83522b305 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Filippi Date: Thu, 19 Jun 2025 10:16:58 +0200 Subject: [PATCH 01/20] Paper fixed --- paper/paper.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paper/paper.md b/paper/paper.md index 1e8b688..866f74d 100644 --- a/paper/paper.md +++ b/paper/paper.md @@ -62,7 +62,7 @@ authors: corresponding: false - name: Alberto Alonso-Pinar orcid: 0009-0009-2051-9700 - affiliation: [1, 3] + affiliation: "1, 3" corresponding: false affiliations: From 7f2ead035944a57bb03b1eaba11503737a51ecaa Mon Sep 17 00:00:00 2001 From: antonio-leblanc Date: Tue, 26 Aug 2025 06:18:01 -0300 Subject: [PATCH 02/20] rm wrong 'input=' instruction from include command #105 --- docs/source/getting_started/running_the_example.rst | 4 ++-- docs/source/user_guide/forefire_script.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/getting_started/running_the_example.rst b/docs/source/getting_started/running_the_example.rst index e53c457..4106ef2 100644 --- a/docs/source/getting_started/running_the_example.rst +++ b/docs/source/getting_started/running_the_example.rst @@ -84,7 +84,7 @@ This method starts the ForeFire interpreter first, allowing you to execute the s .. code-block:: none - forefire> include[input=real_case.ff] + forefire> include[real_case.ff] 4. **Observe:** The simulation will run similarly to Method 1, executing the commands from ``real_case.ff`` and printing output to the console. Afterwards, you remain in the interactive console (``forefire>`` prompt) and can inspect parameters (e.g., ``getParameter[propagationModel]``), run further steps manually (e.g., ``step[dt=600]``), or exit using ``quit[]``. @@ -127,7 +127,7 @@ This method uses the built-in HTTP server to provide a web-based console and map 4. **Use the Web Interface:** - Open your browser to ``http://localhost:8000/`` (or the specified port). - - In the command input box in the web UI, type ``include[input=real_case.ff]`` and press Enter or click Send. This executes the script file relative to where the interpreter was started (which we ensured was `tests/runff`). + - In the command input box in the web UI, type ``include[real_case.ff]`` and press Enter or click Send. This executes the script file relative to where the interpreter was started (which we ensured was `tests/runff`). - Click "Refresh Map" periodically to see the simulation progress visually. You can also type other commands directly into the web console. Choosing a Method diff --git a/docs/source/user_guide/forefire_script.rst b/docs/source/user_guide/forefire_script.rst index cf7cc20..7223220 100644 --- a/docs/source/user_guide/forefire_script.rst +++ b/docs/source/user_guide/forefire_script.rst @@ -67,7 +67,7 @@ While the exact commands depend on the simulation, a common workflow within a `` .. code-block:: none # Include parameters from a separate file (optional) - # include[input=params.ff] + # include[params.ff] # Set specific parameters directly setParameters[propagationModel=Rothermel;perimeterResolution=30;dumpMode=geojson] From 846e85f966815ff31800ca21fa16c1578bf4438c Mon Sep 17 00:00:00 2001 From: CI BOT Date: Tue, 26 Aug 2025 09:29:18 +0000 Subject: [PATCH 03/20] ci: increment version [skip ci] --- src/include/Version.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/include/Version.h b/src/include/Version.h index 3a45bb6..16783a5 100644 --- a/src/include/Version.h +++ b/src/include/Version.h @@ -1,3 +1,3 @@ #pragma once -const char* ff_version = "v2.1.114"; +const char* ff_version = "v2.1.115"; From 5c9785ae458dd526d211604b1604c336e97801d9 Mon Sep 17 00:00:00 2001 From: antonio-leblanc Date: Tue, 26 Aug 2025 06:37:11 -0300 Subject: [PATCH 04/20] try unbreak docs --- docs/source/requirements.txt | 36 +++++++++++------------------------- 1 file changed, 11 insertions(+), 25 deletions(-) diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt index 063a9e6..a0d135b 100644 --- a/docs/source/requirements.txt +++ b/docs/source/requirements.txt @@ -1,25 +1,11 @@ -alabaster==1.0.0 -babel==2.17.0 -breathe==4.36.0 -certifi==2025.1.31 -charset-normalizer==3.4.1 -docutils==0.21.2 -idna==3.10 -imagesize==1.4.1 -Jinja2==3.1.6 -MarkupSafe==3.0.2 -packaging==24.2 -Pygments==2.19.1 -requests==2.32.4 -snowballstemmer==2.2.0 -Sphinx==8.1.3 -sphinx-rtd-theme==3.0.2 -sphinxcontrib-applehelp==2.0.0 -sphinxcontrib-devhelp==2.0.0 -sphinxcontrib-htmlhelp==2.1.0 -sphinxcontrib-jquery==4.1 -sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==2.0.0 -sphinxcontrib-serializinghtml==2.0.0 -tomli==2.2.1 -urllib3==2.3.2 +# Core documentation generator +sphinx>=8.1,<9.0 + +# Theme for Read the Docs +sphinx-rtd-theme>=3.0,<4.0 + +# Doxygen/C++ integration +breathe>=4.36,<5.0 + +# A dependency for the RTD theme +sphinxcontrib-jquery \ No newline at end of file From 638a512474c8365fac75e11dead4e218fadf32da Mon Sep 17 00:00:00 2001 From: CI BOT Date: Tue, 26 Aug 2025 09:37:25 +0000 Subject: [PATCH 05/20] ci: increment version [skip ci] --- src/include/Version.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/include/Version.h b/src/include/Version.h index 16783a5..6772e5c 100644 --- a/src/include/Version.h +++ b/src/include/Version.h @@ -1,3 +1,3 @@ #pragma once -const char* ff_version = "v2.1.115"; +const char* ff_version = "v2.1.116"; From cfad916d9d7f82285c2576d6ab12128c4d168fb3 Mon Sep 17 00:00:00 2001 From: antonio-leblanc Date: Tue, 26 Aug 2025 07:08:16 -0300 Subject: [PATCH 06/20] improve run example #105 --- docs/source/getting_started/quickstart.rst | 9 ++++++++- docs/source/getting_started/running_the_example.rst | 7 +++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/source/getting_started/quickstart.rst b/docs/source/getting_started/quickstart.rst index 85e2897..755be60 100644 --- a/docs/source/getting_started/quickstart.rst +++ b/docs/source/getting_started/quickstart.rst @@ -76,7 +76,7 @@ Steps :align: center :width: 90% - **This confirms your Docker setup is working!** For other ways to run ForeFire scripts (like directly from the command line), see the :doc:`running_the_example` page. + **This confirms your Docker setup is working!** 9. **Stop the Container:** @@ -85,3 +85,10 @@ Steps - In the ForeFire console (either web or terminal inside the container), type `quit`. - In the container's bash shell (terminal), type `exit`. - The `docker run` command used `--rm`, so the container will be automatically removed upon exit. + +.. rubric:: Next Steps + +Congratulations! You've successfully run your first ForeFire simulation and have a working environment. Here are some recommended next steps to deepen your understanding: + +- **Explore Execution Modes:** Learn about the command-line (batch) and interactive console alternatives to the Web UI by reading the :doc:`running_the_example` guide. +- **Understand the Script:** To see what was inside the ``real_case.ff`` script you just ran, dive into the :doc:`/user_guide/forefire_script` guide. diff --git a/docs/source/getting_started/running_the_example.rst b/docs/source/getting_started/running_the_example.rst index 4106ef2..594cbc4 100644 --- a/docs/source/getting_started/running_the_example.rst +++ b/docs/source/getting_started/running_the_example.rst @@ -51,7 +51,10 @@ This is the simplest way to run a simulation non-interactively by feeding the en ../../bin/forefire -i real_case.ff -3. **Observe:** ForeFire will print status messages to the console as it executes the commands within ``real_case.ff``. It will likely create output files (as specified by ``print``/``save`` commands in the script) in the current directory (``tests/runff``). +3. **Observe:** ForeFire will create 2 files: + + - ``to_reload.ff``: a Forefire ascii state file ready to be reincluded or modified to run + - ``ForeFire.0.nc``: a burnig map matrix in netcdf 2: Interactive Console ~~~~~~~~~~~~~~~~~~~~~~ @@ -87,7 +90,7 @@ This method starts the ForeFire interpreter first, allowing you to execute the s forefire> include[real_case.ff] -4. **Observe:** The simulation will run similarly to Method 1, executing the commands from ``real_case.ff`` and printing output to the console. Afterwards, you remain in the interactive console (``forefire>`` prompt) and can inspect parameters (e.g., ``getParameter[propagationModel]``), run further steps manually (e.g., ``step[dt=600]``), or exit using ``quit[]``. +4. **Observe:** The simulation will run similarly to Method 1, executing the commands from ``real_case.ff``. Afterwards, you remain in the interactive console (``forefire>`` prompt) and can inspect parameters (e.g., ``getParameter[propagationModel]``), run further steps manually (e.g., ``step[dt=600]``), or exit using ``quit[]``. 3: Web Interface ~~~~~~~~~~~~~~~~ From 854cef874c7fd814074985d22fda75ac81809c66 Mon Sep 17 00:00:00 2001 From: CI BOT Date: Tue, 26 Aug 2025 10:08:31 +0000 Subject: [PATCH 07/20] ci: increment version [skip ci] --- src/include/Version.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/include/Version.h b/src/include/Version.h index 16783a5..6772e5c 100644 --- a/src/include/Version.h +++ b/src/include/Version.h @@ -1,3 +1,3 @@ #pragma once -const char* ff_version = "v2.1.115"; +const char* ff_version = "v2.1.116"; From 0f1a98f874763167edf050d3f419c11761ce7ab6 Mon Sep 17 00:00:00 2001 From: antonio-leblanc Date: Tue, 26 Aug 2025 07:16:48 -0300 Subject: [PATCH 08/20] better clarity #105 --- docs/source/getting_started/running_the_example.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/source/getting_started/running_the_example.rst b/docs/source/getting_started/running_the_example.rst index 594cbc4..401f690 100644 --- a/docs/source/getting_started/running_the_example.rst +++ b/docs/source/getting_started/running_the_example.rst @@ -3,7 +3,15 @@ Running an Example ================== -After successfully installing ForeFire (either :doc:`from source ` or via :doc:`Docker `), you can run the example simulation located in the ``tests/runff/`` directory. This helps verify your installation and introduces you to the basic command execution methods. +In the :doc:`quickstart` guide, you launched the example simulation using the interactive Web UI. That is just one of several ways to operate the ``forefire`` interpreter. + +This page details all three primary execution modes, allowing you to choose the best method for your specific task: + +- **Direct Execution (Batch Mode):** Best for standard, non-interactive runs or for use in automated scripts. +- **Interactive Console:** Ideal for experimenting with commands step-by-step or inspecting the simulation state. +- **Web Interface:** Excellent for visual feedback and interactive demonstrations. + +Below, we demonstrate each method using the same ``real_case.ff`` script. Simulation Files Used --------------------- @@ -95,7 +103,7 @@ This method starts the ForeFire interpreter first, allowing you to execute the s 3: Web Interface ~~~~~~~~~~~~~~~~ -This method uses the built-in HTTP server to provide a web-based console and map visualization. It executes commands in the same way as the interactive console but through your browser. +This method, which you may have already used in the :doc:`quickstart` guide, uses the built-in HTTP server to provide a web-based console and map visualization. It executes commands in the same way as the interactive console but through your browser. 1. **Navigate to the test directory** (if not already there): From 8cf166bb2bace1757873519fe21cf86b3674fdf8 Mon Sep 17 00:00:00 2001 From: CI BOT Date: Tue, 26 Aug 2025 10:17:02 +0000 Subject: [PATCH 09/20] ci: increment version [skip ci] --- src/include/Version.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/include/Version.h b/src/include/Version.h index 6772e5c..ce9c355 100644 --- a/src/include/Version.h +++ b/src/include/Version.h @@ -1,3 +1,3 @@ #pragma once -const char* ff_version = "v2.1.116"; +const char* ff_version = "v2.1.117"; From 555aa423e2640b04c8c38a37ed4d41a21e56412b Mon Sep 17 00:00:00 2001 From: antonio-leblanc Date: Tue, 26 Aug 2025 07:18:42 -0300 Subject: [PATCH 10/20] execution modes page #105 --- .../{running_the_example.rst => execution_modes.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/source/getting_started/{running_the_example.rst => execution_modes.rst} (100%) diff --git a/docs/source/getting_started/running_the_example.rst b/docs/source/getting_started/execution_modes.rst similarity index 100% rename from docs/source/getting_started/running_the_example.rst rename to docs/source/getting_started/execution_modes.rst From 1bf6b964f9fb2be5f470bdef845065e970b4b69d Mon Sep 17 00:00:00 2001 From: CI BOT Date: Tue, 26 Aug 2025 10:18:57 +0000 Subject: [PATCH 11/20] ci: increment version [skip ci] --- src/include/Version.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/include/Version.h b/src/include/Version.h index ce9c355..d8f281f 100644 --- a/src/include/Version.h +++ b/src/include/Version.h @@ -1,3 +1,3 @@ #pragma once -const char* ff_version = "v2.1.117"; +const char* ff_version = "v2.1.118"; From 228049d46f7359bcc8287d2bde51a6caef7b358c Mon Sep 17 00:00:00 2001 From: antonio-leblanc Date: Tue, 26 Aug 2025 07:22:55 -0300 Subject: [PATCH 12/20] executions modes page #105 --- docs/source/getting_started/execution_modes.rst | 2 +- docs/source/getting_started/quickstart.rst | 2 +- docs/source/index.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/getting_started/execution_modes.rst b/docs/source/getting_started/execution_modes.rst index 401f690..3aff9c0 100644 --- a/docs/source/getting_started/execution_modes.rst +++ b/docs/source/getting_started/execution_modes.rst @@ -1,6 +1,6 @@ .. _running-the-example: -Running an Example +Execution Modes ================== In the :doc:`quickstart` guide, you launched the example simulation using the interactive Web UI. That is just one of several ways to operate the ``forefire`` interpreter. diff --git a/docs/source/getting_started/quickstart.rst b/docs/source/getting_started/quickstart.rst index 755be60..ac5d2f3 100644 --- a/docs/source/getting_started/quickstart.rst +++ b/docs/source/getting_started/quickstart.rst @@ -90,5 +90,5 @@ Steps Congratulations! You've successfully run your first ForeFire simulation and have a working environment. Here are some recommended next steps to deepen your understanding: -- **Explore Execution Modes:** Learn about the command-line (batch) and interactive console alternatives to the Web UI by reading the :doc:`running_the_example` guide. +- **Explore Execution Modes:** Learn about the command-line (batch) and interactive console alternatives to the Web UI by reading the :doc:`execution_modes` guide. - **Understand the Script:** To see what was inside the ``real_case.ff`` script you just ran, dive into the :doc:`/user_guide/forefire_script` guide. diff --git a/docs/source/index.rst b/docs/source/index.rst index 9170a1b..5419b66 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,7 +15,7 @@ Welcome to the official documentation for ForeFire — the open-source wildfire getting_started/introduction getting_started/quickstart getting_started/installation - getting_started/running_the_example + getting_started/execution_modes .. toctree:: :maxdepth: 1 From 8b7151920a9a57148cbba7ecb6795d038687fb45 Mon Sep 17 00:00:00 2001 From: CI BOT Date: Tue, 26 Aug 2025 10:23:09 +0000 Subject: [PATCH 13/20] ci: increment version [skip ci] --- src/include/Version.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/include/Version.h b/src/include/Version.h index d8f281f..51d8026 100644 --- a/src/include/Version.h +++ b/src/include/Version.h @@ -1,3 +1,3 @@ #pragma once -const char* ff_version = "v2.1.118"; +const char* ff_version = "v2.1.119"; From 413c762e5d5e62bfcb82686c48b0e8a9eb4f9bd1 Mon Sep 17 00:00:00 2001 From: antonio-leblanc Date: Tue, 26 Aug 2025 07:27:19 -0300 Subject: [PATCH 14/20] typos --- docs/source/getting_started/introduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting_started/introduction.rst b/docs/source/getting_started/introduction.rst index e997f23..b96bd31 100644 --- a/docs/source/getting_started/introduction.rst +++ b/docs/source/getting_started/introduction.rst @@ -51,7 +51,7 @@ ForeFire is suitable for a range of applications, including: Supported Platforms ------------------- -ForeFire is primarily developed and tested on **Unix-like systems (Linux and macOS)**. It can run o Windows via **WSL** (windows Subsystem for Linux) or **Docker**. +ForeFire is primarily developed and tested on **Unix-like systems (Linux and macOS)**. It can run on Windows via **WSL** (Windows Subsystem for Linux) or **Docker**. About This Documentation ------------------------ From 5df4ebad38c2a1d3e21572d3b52ae82ab3d2b24a Mon Sep 17 00:00:00 2001 From: CI BOT Date: Tue, 26 Aug 2025 10:27:32 +0000 Subject: [PATCH 15/20] ci: increment version [skip ci] --- src/include/Version.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/include/Version.h b/src/include/Version.h index 51d8026..cb289f1 100644 --- a/src/include/Version.h +++ b/src/include/Version.h @@ -1,3 +1,3 @@ #pragma once -const char* ff_version = "v2.1.119"; +const char* ff_version = "v2.1.120"; From f093d2f7668cb44ba648dbded0042a48bb6d4e0e Mon Sep 17 00:00:00 2001 From: antonio-leblanc Date: Tue, 26 Aug 2025 07:32:14 -0300 Subject: [PATCH 16/20] typos --- docs/source/getting_started/execution_modes.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/getting_started/execution_modes.rst b/docs/source/getting_started/execution_modes.rst index 3aff9c0..ad13b09 100644 --- a/docs/source/getting_started/execution_modes.rst +++ b/docs/source/getting_started/execution_modes.rst @@ -62,7 +62,7 @@ This is the simplest way to run a simulation non-interactively by feeding the en 3. **Observe:** ForeFire will create 2 files: - ``to_reload.ff``: a Forefire ascii state file ready to be reincluded or modified to run - - ``ForeFire.0.nc``: a burnig map matrix in netcdf + - ``ForeFire.0.nc``: a burning map matrix in netcdf 2: Interactive Console ~~~~~~~~~~~~~~~~~~~~~~ @@ -131,7 +131,7 @@ This method, which you may have already used in the :doc:`quickstart` guide, use Alternatively, to launch the HTTP server directly without entering the interactive console first, you can use the `-l` command-line option. This is convenient if you primarily want to use the web interface. - .. code-block:: none + .. code-block:: bash forefire -l From d3eb366126686f99a93585e4b8f03f99b43adc77 Mon Sep 17 00:00:00 2001 From: CI BOT Date: Tue, 26 Aug 2025 10:32:30 +0000 Subject: [PATCH 17/20] ci: increment version [skip ci] --- src/include/Version.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/include/Version.h b/src/include/Version.h index cb289f1..b3b4c3f 100644 --- a/src/include/Version.h +++ b/src/include/Version.h @@ -1,3 +1,3 @@ #pragma once -const char* ff_version = "v2.1.120"; +const char* ff_version = "v2.1.121"; From a91327f37db7201afdb2f4df9d8f8f83189ef872 Mon Sep 17 00:00:00 2001 From: antonio-leblanc Date: Tue, 26 Aug 2025 07:35:11 -0300 Subject: [PATCH 18/20] page name --- docs/source/getting_started/execution_modes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting_started/execution_modes.rst b/docs/source/getting_started/execution_modes.rst index ad13b09..899e858 100644 --- a/docs/source/getting_started/execution_modes.rst +++ b/docs/source/getting_started/execution_modes.rst @@ -1,4 +1,4 @@ -.. _running-the-example: +.. _execution_modes: Execution Modes ================== From 7643d0090a3caaadad64b932f19085a45bc872f8 Mon Sep 17 00:00:00 2001 From: CI BOT Date: Tue, 26 Aug 2025 10:35:25 +0000 Subject: [PATCH 19/20] ci: increment version [skip ci] --- src/include/Version.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/include/Version.h b/src/include/Version.h index b3b4c3f..812f01e 100644 --- a/src/include/Version.h +++ b/src/include/Version.h @@ -1,3 +1,3 @@ #pragma once -const char* ff_version = "v2.1.121"; +const char* ff_version = "v2.1.122"; From 28bfb3f591e59e72c9a4b18e24ffb260d04bcbd6 Mon Sep 17 00:00:00 2001 From: antonio-leblanc Date: Tue, 26 Aug 2025 07:39:19 -0300 Subject: [PATCH 20/20] probably better --- .github/workflows/increment-version.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/increment-version.yml b/.github/workflows/increment-version.yml index 1329545..88ae105 100644 --- a/.github/workflows/increment-version.yml +++ b/.github/workflows/increment-version.yml @@ -2,7 +2,8 @@ name: Increment Version on Dev on: push: - # branches: [ dev ] we can add back later if needed + # we can add back to branch dev if needed + branches: [ dev2 ] workflow_dispatch: jobs: