FDSReader
Fast and easy-to-use Python reader for FDS data
FDS Version Compatibility
| fdsreader | FDS 6.7 | FDS 6.8 | FDS 6.9 | FDS 6.10 |
|---|---|---|---|---|
| ≤ 1.11.x | ✅ | ✅ | ✅ | ⚠️ (Geometry bug, #TODO) |
| 1.12.x (planned) | ✅ | ✅ | ✅ | ✅ |
Tested against FDS outputs. If you find a compatibility issue please open an issue.
Installation
The package is available on PyPI and can be installed using pip:
pip install fdsreader
FDS Version 6.7.5 and above are fully supported. Versions below 6.7.5 might work, but are not guaranteed to work.
Usage example
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.
Configuration
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. |
Data structure
Beware that not all attributes and methods are covered in this diagram. For a complete documentation of all classes check the API Documentation below.
API Documentation
https://fdsreader.readthedocs.io
Releasing a new version
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.0
This triggers the release workflow which builds the package and publishes it to PyPI.
Meta
- Jan Vogelsang – j.vogelsang@fz-juelich.de
- Marc Fehr - m.fehr@fz-juelich.de
- Kristian Börger - k.boerger@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
Contributing
See CONTRIBUTING.md for development setup, how to run tests, and the PR checklist.
3 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fdsreader-1.11.9.tar.gz.
File metadata
- Download URL: fdsreader-1.11.9.tar.gz
- Upload date:
- Size: 188.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a54fb855799d173000b17d0ade7eff977dee0bf6f8d9be76dc00a0754d484ee
|
|
| MD5 |
3f809f44191985201b4b13c881402f01
|
|
| BLAKE2b-256 |
7c1fcfdecb0d1de71939730ee14a1ba7b3ab6253b4c5990b686d33cb1fd96d39
|
Provenance
The following attestation bundles were made for fdsreader-1.11.9.tar.gz:
Publisher:
release.yml on FireDynamics/fdsreader
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fdsreader-1.11.9.tar.gz -
Subject digest:
9a54fb855799d173000b17d0ade7eff977dee0bf6f8d9be76dc00a0754d484ee - Sigstore transparency entry: 2205375941
- Sigstore integration time:
-
Permalink:
FireDynamics/fdsreader@42a1456f3596ee160798a52a77cc003cc0dc61f9 -
Branch / Tag:
refs/tags/v1.11.9 - Owner: https://github.com/FireDynamics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@42a1456f3596ee160798a52a77cc003cc0dc61f9 -
Trigger Event:
push
-
Statement type:
File details
Details for the file fdsreader-1.11.9-py3-none-any.whl.
File metadata
- Download URL: fdsreader-1.11.9-py3-none-any.whl
- Upload date:
- Size: 113.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
251918e960480c39939b87e67756e4653eac043db11e34f90643107f553cb237
|
|
| MD5 |
74eef11460998b1885b2e45748997204
|
|
| BLAKE2b-256 |
bce0c6cdba4596c4ba98a8eeab46065d23bf8391326c00369f37570f667c03b5
|
Provenance
The following attestation bundles were made for fdsreader-1.11.9-py3-none-any.whl:
Publisher:
release.yml on FireDynamics/fdsreader
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fdsreader-1.11.9-py3-none-any.whl -
Subject digest:
251918e960480c39939b87e67756e4653eac043db11e34f90643107f553cb237 - Sigstore transparency entry: 2205375960
- Sigstore integration time:
-
Permalink:
FireDynamics/fdsreader@42a1456f3596ee160798a52a77cc003cc0dc61f9 -
Branch / Tag:
refs/tags/v1.11.9 - Owner: https://github.com/FireDynamics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@42a1456f3596ee160798a52a77cc003cc0dc61f9 -
Trigger Event:
push
-
Statement type:
