Fast and easy-to-use Python reader for FDS data
| fdsreader | FDS 6.7 | FDS 6.8 | FDS 6.9 | FDS 6.10 |
|---|---|---|---|---|
| ≤ 1.11.x | ✅ | ✅ | ✅ | |
| 1.12.x (planed) | ✅ | ✅ | ✅ | ✅ |
Tested against FDS outputs. If you find a compatibility issue please open an issue.
The package is available on PyPI and can be installed using pip:
pip install fdsreaderFDS Version 6.7.5 and above are fully supported. Versions below 6.7.5 might work, but are not guaranteed to work.
import fdsreader as fds
# Creates an instance of a simulation master-class which manages all data for a given simulation
sim = fds.Simulation("./sample_data")
# Examples of data that can be easily accessed
print(sim.meshes, sim.surfaces, sim.slices, sim.data_3d, sim.smoke_3d, sim.isosurfaces, sim.particles, sim.obstructions)More advanced examples can be found in the respective data type directories inside of the examples directory.
The package provides a few configuration options that can be set using the settings module.
fds.settings.KEY = VALUE
# Example
fds.settings.DEBUG = True| KEY | VALUE | Default | Description |
|---|---|---|---|
| LAZY_LOAD | boolean | True | Load all data when initially loading the simulation (False) or only when specific data is needed (True). |
| ENABLE_CACHING | boolean | True | Cache the loaded simulation to reduce startup times when loading the same simulation again. |
| DEBUG | boolean | False | Crash on non-critical errors with an exception (True) or output non-critical errors as warnings (False). |
| IGNORE_ERRORS | boolean | False | Ignore any non-critical errors completely. |
Beware that not all attributes and methods are covered in this diagram. For a complete documentation of all classes check the API Documentation below.
https://fdsreader.readthedocs.io
Versioning is handled automatically via Git tags using setuptools-scm.
# New release
git tag -a v1.12.0 -m "Version 1.12.0"
git push origin v1.12.0This triggers the release workflow which builds the package and publishes it to PyPI.
- Jan Vogelsang – j.vogelsang@fz-juelich.de
- Prof. Dr. Lukas Arnold - l.arnold@fz-juelich.de
Distributed under the LGPLv3 (GNU Lesser General Public License v3) license. See LICENSE for more information.
https://github.com/FireDynamics/fdsreader
See CONTRIBUTING.md for development setup, how to run tests, and the PR checklist.