fdsreader 0.4.7

Python reader for data generated by FDS.

FDSReader

Python reader for FDS data

[One to two paragraph statement about the fdsreader.]

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
import fdsreader.utils as fdsutils

# Recursively scans the directory for all .smv files
smv_file_path = fdsutils.scan_directory_smv("./sample_data")[0]

# Creates an instance of a simulation master-class which manages all data for a given simulation
sim = fds.Simulation(smv_file_path)

# 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)

API Documentation

https://janvogelsang.github.io/fdsreader/

Release History

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

Beta (Q1 2021)

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

Alpha (end of 2020)

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

--> Pre-Alpha

• 0.4.7
  • Added cache clearing functionality
• 0.4.6
  • Added automatic caching for simulations (which significantly reduces simulation loading time)
  • 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 and bndf stability
• 0.4.4
  • Bugfixes for bndf and plot3d
• 0.4.3
  • Bugfixes for slcf and isof readers
• 0.4.2
  • Completed API documentation
• 0.4.1
  • Fixed 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 (multimesh slices)
  • Added API documentation
  • Package available on PyPI
• 0.1.0
  • Added basic slcf support (slices)

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/JanVogelsang/fdsreader

Contributing

1. Fork it (https://github.com/JanVogelsang/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