Install
Install pyFDS-Evac, run one scenario to check the install, and know what else you need for your own FDS cases.
Requirements
| Needed | For |
|---|---|
| Python 3.11 or 3.12 | pyFDS-Evac itself (requires-python = ">=3.11,<3.13") |
| uv | the environment, the examples and every command on this site |
| git and network access | fdsvismap is installed from its git repository, pinned to one commit |
| FDS (optional) | only to run your own fire; pyFDS-Evac reads the output of a finished FDS run and never starts FDS |
| ffmpeg (optional) | only for the MP4 of scripts/animate_cognitive_map.py |
pyFDS-Evac is not on PyPI yet. The release waits on an upstream fdsvismap merge.
Install from the repository
The examples and the tracked scenarios live in the repository (examples/,
assets/), so clone it:
git clone https://github.com/PedestrianDynamics/pyFDS-Evac.git
cd pyFDS-Evac
uv syncFor the optional web GUI, add its extra:
uv sync --extra guiCheck the install
uv run python run.py --scenario assets/ISO-table21 --cleanupLibrary only
To use pyFDS-Evac as a library in another project, install the package from git:
pip install "pyfds-evac @ git+https://github.com/PedestrianDynamics/pyFDS-Evac.git"The package contains pyfds_evac only. run.py, examples/, scripts/ and
assets/ are not in it.
Next steps
- Quickstart: one run with smoke, and what the numbers mean.
- Troubleshooting: if a command on this site fails.
Last updated on