fdsreader 0.5.0

Python reader for data generated by FDS.

FDSReader

Fast and easy-to-use Python reader for FDS data

Installation

The package is available on PyPI and can be installed using pip:

python -m pip install --upgrade fdsreader

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.meshes[0].obstructions, sim.surfaces, sim.slices, sim.boundaries, sim.data_3d, sim.isosurfaces)

Data structure

API Documentation

https://firedynamics.github.io/fdsreader/

Release History

• (unreleased) 1.0.0
  • (First official version will be released after sufficient public testing in beta stage)

Beta (Q1 2021)

• (unreleased) 0.9.0
  • (Entering beta status after extensive testing with selected participants in alpha stage)

Alpha (01/2021)

• (unreleased) 0.x.0
  • (Entering alpha status after extensive private testing in pre-alpha stage)

Pre-Alpha (current stage)

• 0.5.0
  • Preparing for alpha release
  • Usability improvements for simulation
  • Usability improvements for part
  • Added devc support (devices)
  • Added part support (particles)
  • Bugfixes for bndf
• 0.4.10
  • Bugfixes for slcf
• 0.4.9
  • Bugfixes for bndf
  • Improved 2D-Slice functionality
• 0.4.8
  • Complete rework of internal reading process (higher performance)
  • Complete rework of bndf
  • Bugfixes (obstructions, extents, simulation)
• 0.4.7
  • Added cache clearing functionality
  • Bugfixes
• 0.4.6
  • Added automatic caching for simulations (significant loading time reduction)
  • Reworked internal slcf data structure
  • Fixed isof reader (now correctly reads in data for all time steps)
  • Connected bndf data to obstructions
  • Simplified instantiation of Simulation objects
• 0.4.5
  • Added multimesh isof support
  • Improved slcf stability
• 0.4.4
  • Bugfixes (bndf and plot3d)
• 0.4.3
  • Bugfixes (slcf and isof)
• 0.4.2
  • Completed API documentation
• 0.4.1
  • Bugfixes (python import issues)
• 0.4.0
  • Added bndf support (boundaries)
• 0.3.0
  • Added multimesh plot3D support
• 0.3.0
  • Added basic plot3D support
• 0.2.0
  • Added isof support (isosurfaces)
• 0.1.2
  • Added numpy support for slices
• 0.1.1
  • Added multimesh slcf support
  • Added API documentation
  • Package available on PyPI
• 0.1.0
  • Added basic slcf support (2D + 3D slices)

Known bugs

• Some issues with bndf
• Particles reader

Meta

• Jan Vogelsang – [e-mail]
• Prof. Dr. Lukas Arnold - [e-mail]

Distributed under the LGPLv3 (GNU Lesser General Public License v3) license. See LICENSE for more information.

https://github.com/FireDynamics/fdsreader

Contributing

1. Fork it (https://github.com/FireDynamics/fdsreader/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request