https://github.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin
QGIS>Plugins>ManageAnd...>Settings>Add>URL: https://fire2a.github.io/fire-analytics-qgis-processing-toolbox-plugin/plugins.xml Search:Fire>Install Plugin
https://github.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin
fire landscape research simulation wildfire
Last synced: 4 months ago
JSON representation
QGIS>Plugins>ManageAnd...>Settings>Add>URL: https://fire2a.github.io/fire-analytics-qgis-processing-toolbox-plugin/plugins.xml Search:Fire>Install Plugin
- Host: GitHub
- URL: https://github.com/fire2a/fire-analytics-qgis-processing-toolbox-plugin
- Owner: fire2a
- License: agpl-3.0
- Created: 2023-08-31T14:56:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-29T23:40:21.000Z (5 months ago)
- Last Synced: 2026-01-30T10:36:25.914Z (5 months ago)
- Topics: fire, landscape, research, simulation, wildfire
- Language: Python
- Homepage: https://fire2a.github.io/docs/
- Size: 7.73 MB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FireAnalyticsToolbox
This repo sources Fire2a(.com research group)'s QGIS-Processing-Toolbox plugin: _"FireAnalyticsToolbox"_
User tutorials are at [fire2a/docs](https://fire2a.github.io/docs/)
Tutoriales para usuarios español en: [fire2a/documentacion](https://fire2a.github.io/documentacion/)
## Quickstart
### Install
[comprehensive tutorial here](https://fire2a.github.io/docs/qgis-toolbox)
1. Install [QGIS](https://qgis.org/download/)
1. Install fire2a's custom [plugin repo source](https://fire2a.github.io/fire-analytics-qgis-processing-toolbox-plugin/plugins.xml) (QGIS>Plugins>ManageAnd...>Settings>Add>URL)
1. Install "Fire Analytics Toolbox" plugin (usually needs QGIS restart)
1. (If you canceled the installation prompt on the last step) Install python requirements typing `pip install fire2a-lib` into QGIS python console (restart QGIS)
### Usage options
1. As a window dialog on the [processing toolbox](https://docs.qgis.org/latest/en/docs/user_manual/processing/toolbox.html) interface
1. As a [model (designer graphic interface)](https://docs.qgis.org/latest/en/docs/user_manual/processing/modeler.html) component
1. Via [command line interface](https://docs.qgis.org/latest/en/docs/user_manual/processing/standalone) using `$ qgis_process`
1. Python script, either:
- on [QGIS Python console](https://docs.qgis.org/latest/en/docs/user_manual/plugins/python_console.html)
- or as a [standalone](https://raw.githubusercontent.com/fdobad/fire-analytics-qgis-processing-toolbox-plugin/main/script_samples/standalone.py) script
### Development
- Check a release for directory structure (`fireanalyticstoolbox` is the plugin dir)
- [Fork], Clone
- helper algorithms library [fire2a-lib](https://www.github.com/fire2a/fire2a-lib/), install editable `pip install -e .`
- if simulating fires: submodule-add [C2F-W](https://www.github.com/fire2a/C2F-W/)
- if placing firebreaks (knapsack algorithm) get a MIP solver (coinor-cbc, cplex or gurobi)
- [branch] `git checkout -b myfeature`
- Symlink `fireanalyticstoolbox` into your qgis-plugins directory
- Install "Fire Analytics Toolbox" & "Plugin Reloader" in QGIS Plugin Manager
- Done! (Do a change, reload the plugin, test, ...)
- Pull requests welcome! ([coding style](https://github.com/fire2a/fire2a-lib/blob/main/coding_style.md))
#### How to debug a qgis plugin:
# fmt: off
# Use pdb for debugging
import pdb # isort: skip
# also import pyqtRemoveInputHook
from qgis.PyQt.QtCore import pyqtRemoveInputHook # isort: skip
# These allow you to set a breakpoint in the app
pyqtRemoveInputHook()
pdb.set_trace()
# these allow you explore with ipython
from IPython import embed
embed()
# fmt: on
Also checkout our [algorithms library](https://fire2a.github.io/docs/algo-lib)
## Project structure summary
```
├── fireanalyticstoolbox # QGIS plugin directory
│ ├── __init__.py
│ ├── algorithms_*.py
│ ├── _provider.py
│ ├── decision_optimization # MIP integration
│ ├── i18n # translation
│ └── simulator # wildfire integration
│ ├── C2F ⇒ symlink or copy C2F-W HERE!
│ └── fuel model tables.csv
├── graphical_models # QGIS models samples
│ └── *.model3
├── script_samples # alternative usage samples
│ ├── qgis_console.py
│ ├── qgis_process.sh
│ └── standalone.py
├── test # pytest[-qgis][-dependency]
└── pyproject.toml
```
## Code of Conduct
Everyone interacting in the project's codebases, issue trackers, etc. is expected to follow the [PSF Code of Conduct](https://www.python.org/psf/conduct/).