fdsreader 1.10.2__tar.gz → 1.10.3__tar.gz

fdsreader-1.10.3/.gitattributes

@@ -0,0 +1 @@
+*.tgz filter=lfs diff=lfs merge=lfs -text

fdsreader-1.10.3/.github/workflows/joss.yml

@@ -0,0 +1,36 @@
+name: FDSreader JOSS submission paper
+
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - master
+    paths:
+      - 'paper.md'
+      - 'paper.bib'
+  pull_request:
+    paths:
+      - 'paper.md'
+      - 'paper.bib'
+
+permissions:
+  contents: read
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v1
+        with:
+          name: paper
+          path: paper.pdf

fdsreader-1.10.3/.github/workflows/testsuite.yml

@@ -0,0 +1,42 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: FDSreader testsuite
+
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - master
+    paths:
+      - 'fdsreader/**'
+  pull_request:
+    paths:
+      - 'fdsreader/**'
+
+permissions:
+  contents: read
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        lfs: true
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.10' 
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest numpy
+        pip install ${{ github.workspace }}
+    - name: Prepare test cases
+      run: |
+        cd ${{ github.workspace }}/tests/cases/
+        for f in *.tgz; do tar -xzvf "$f"; done
+    - name: Test with pytest
+      run: |
+        cd ${{ github.workspace }}/tests/cases
+        pytest ../acceptance_tests/

{fdsreader-1.10.2 → fdsreader-1.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fdsreader
-Version: 1.10.2
+Version: 1.10.3
 Summary: Python reader for data generated by FDS.
 Home-page: https://github.com/FireDynamics/fdsreader
 Author: FZJ IAS-7 (Jan Vogelsang, Prof. Dr. Lukas Arnold, Tristan Hehnen)
@@ -89,7 +89,7 @@ It is also possible to deploy to PyPI and Github pages manually using the follow
 3. sphinx-build -b html docs docs/build
 4. cd .. && mkdir gh-pages && cd gh-pages
 5. git init && git remote add origin git@github.com:FireDynamics/fdsreader.git
-6. git fetch --all
+6. git fetch origin gh-pages:gh-pages
 7. git checkout gh-pages
 8. cp -r ../fdsreader/docs/build/* .
 9. git add . && git commit -m "..." && git push origin HEAD:gh-pages

{fdsreader-1.10.2 → fdsreader-1.10.3}/README.md

@@ -72,7 +72,7 @@ It is also possible to deploy to PyPI and Github pages manually using the follow
 3. sphinx-build -b html docs docs/build
 4. cd .. && mkdir gh-pages && cd gh-pages
 5. git init && git remote add origin git@github.com:FireDynamics/fdsreader.git
-6. git fetch --all
+6. git fetch origin gh-pages:gh-pages
 7. git checkout gh-pages
 8. cp -r ../fdsreader/docs/build/* .
 9. git add . && git commit -m "..." && git push origin HEAD:gh-pages

{fdsreader-1.10.2 → fdsreader-1.10.3}/RELEASE.md

@@ -1,4 +1,7 @@
 ## Release History
+* 1.10.3
+    * Fixed particle documentation
+    * Fixed bug for particles when using more than one quantity
 * 1.10.2
     * Fixed to_global function for Plot3D data with obstruction masks
     * Fixed to_global function for Smoke3D data with obstruction masks

{fdsreader-1.10.2 → fdsreader-1.10.3}/examples/bndf/bndf_example_anim.py

@@ -2,9 +2,7 @@ import matplotlib.pyplot as plt
 import matplotlib.animation as animation
 import numpy as np
 
-import fdsreader.settings
 from fdsreader import Simulation
-from fdsreader.bndf.utils import sort_patches_cartesian
 
 
 def main():

{fdsreader-1.10.2 → fdsreader-1.10.3}/examples/bndf/fds_data/wall_005.fds

@@ -1,6 +1,6 @@
-&HEAD CHID='wall_test'
-      /
-&TIME T_END=20.0
+&HEAD CHID='wall_test' /
+
+&TIME T_END=20.0, TIME_SHRINK_FACTOR=10./
 
 &MULT ID='mesh', DX=1, DY=0.8, I_UPPER=3, J_UPPER=5,/
 
@@ -86,7 +86,7 @@
 
 
 &VENT XB=-0.3,1.1,0.4,1.7,0.45,0.45 SURF_ID='Brandfläche'/
-&REAC ID='Brandfläche', FUEL='PUR', SPEC_ID_NU = 'PUR','AIR','PRODUCTS', NU= -1,-4.043567,1./
+&REAC ID='Brandfläche', FUEL='PUR', SPEC_ID_NU = 'PUR','AIR','PRODUCTS', NU= -1,-4.043567,1., HEAT_OF_COMBUSTION=40000  /
 &SURF ID='Brandfläche',SPEC_ID='PUR', HRRPUA=2823.129, COLOR='RED', RAMP_Q='fire_ramp'/
 
 /Vorgabe der Brandkurve

{fdsreader-1.10.2 → fdsreader-1.10.3}/examples/devc/devc_example.py

@@ -4,7 +4,7 @@ import fdsreader as fds
 def main():
     sim = fds.Simulation("./fds_steckler")
 
-    print(sim.devices["TC_Door_Single"].data)
+    print(sim.devices["TC_Door"][0].data)
 
     try:
         df = sim.devices.to_pandas_dataframe()

fdsreader-1.10.3/examples/devc/fds_steckler/steckler.fds

@@ -0,0 +1,43 @@
+&HEAD CHID='Steckler', TITLE='Steckler Compartment'/
+
+&MESH IJK=36,28,22, XB=0.00,3.60,-1.40,1.40,0.00,2.13 /
+
+&TIME T_END=100.0, TIME_SHRINK_FACTOR=10. /
+&DUMP NFRAMES=100, DT_DEVC=10., DT_HRR=10., SIG_FIGS=4, SIG_FIGS_EXP=2 /
+
+&MISC TMPA=22. /
+
+&SURF ID='BURNER',HRRPUA=1048.3,TMP_FRONT=100.,COLOR='ORANGE' /  62.9 kW
+
+&HOLE XB=2.75,2.95,-0.10,0.15,0.00,1.83 / 2/6 Door
+
+&VENT XB=1.30,1.50,-0.10,0.10,0.00,0.00, SURF_ID='BURNER' / Position A
+&VENT XB=1.25,1.30,-0.05,0.05,0.00,0.00, SURF_ID='BURNER' /
+&VENT XB=1.50,1.55,-0.05,0.05,0.00,0.00, SURF_ID='BURNER' /
+&VENT XB=1.35,1.45,-0.15,-.10,0.00,0.00, SURF_ID='BURNER' /
+&VENT XB=1.35,1.45, 0.10,0.15,0.00,0.00, SURF_ID='BURNER' /
+
+&SURF ID='FIBER BOARD', DEFAULT=.TRUE., MATL_ID='INSULATION', THICKNESS=0.013, COLOR='BEIGE' /
+
+&REAC FUEL='METHANE',SOOT_YIELD=0. /
+
+&OBST XB=2.80,2.90,-1.40,1.40,0.00,2.13 / Wall with door or window
+
+&VENT MB='XMAX',SURF_ID='OPEN'/
+&VENT XB= 2.90,3.60,-1.40,-1.40,0.00,2.13, SURF_ID='OPEN'/
+&VENT XB= 2.90,3.60, 1.40, 1.40,0.00,2.13, SURF_ID='OPEN'/
+&VENT XB= 2.90,3.60,-1.40, 1.40,2.13,2.13, SURF_ID='OPEN'/
+
+&MATL ID            = 'INSULATION'
+      DENSITY       = 200.
+      CONDUCTIVITY  = 0.1
+      SPECIFIC_HEAT = 1. /
+
+&DEVC ID='TC_Room', POINTS=44, XB=2.50,2.50,1.10,1.10,0.02,2.11, QUANTITY='TEMPERATURE', Z_ID='Room_z' /
+&DEVC ID='TC_Door', POINTS=38, XB=2.85,2.85,0.00,0.00,0.02,1.82, QUANTITY='TEMPERATURE', Z_ID='Door_z' /
+&DEVC ID='BP_Door', POINTS=38, XB=2.85,2.85,0.00,0.00,0.02,1.82, QUANTITY='VELOCITY', VELO_INDEX=1, HIDE_COORDINATES=.TRUE. /
+
+&DEVC ID='HGL Temp',   XB=2.50,2.50,1.10,1.10,0.00,2.13, QUANTITY='UPPER TEMPERATURE'  /
+&DEVC ID='HGL Height', XB=2.50,2.50,1.10,1.10,0.00,2.13, QUANTITY='LAYER HEIGHT'  /
+
+&TAIL /

{fdsreader-1.10.2 → fdsreader-1.10.3}/examples/geom/fds_data/sphere_radiate.fds

@@ -2,7 +2,7 @@
 
 &MESH IJK=64,64,64, XB=-2.0,2.0,-2.0,2.0,0.0,4.0 /
 
-&TIME T_END=10 /
+&TIME T_END=10, TIME_SHRINK_FACTOR=50. /
 &PRES SOLVER='UGLMAT' /
 
 &SPEC ID='NITROGEN', BACKGROUND=.TRUE. /

{fdsreader-1.10.2 → fdsreader-1.10.3}/examples/geom/geom_example.py

@@ -9,6 +9,8 @@ def main():
     sim = Simulation("./fds_data")
 
     geom = sim.geom_data.filter_by_quantity("Radiative Heat Flux")[0]
+    print(len(geom.data[-1]))
+    exit()
 
     faces = np.hstack(np.append(np.full((geom.faces.shape[0], 1), 3), geom.faces, axis=1))
     pv.PolyData(geom.vertices, faces).plot(scalars=geom.data[0])

fdsreader-1.10.3/examples/isof/fds_steckler/input_steckler.fds

@@ -0,0 +1,40 @@
+&HEAD CHID='Steckler_010', TITLE='Steckler Compartment, Test 10'/
+
+&MESH IJK=36,28,22, XB=0.00,3.60,-1.40,1.40,0.00,2.13 /
+
+&TIME T_END=100.0, TIME_SHRINK_FACTOR=10. /
+&DUMP NFRAMES=100, DT_DEVC=10., DT_HRR=10., SIG_FIGS=4, SIG_FIGS_EXP=2 /
+
+&MISC TMPA=22. /
+
+&SURF ID='BURNER',HRRPUA=1048.3,TMP_FRONT=100.,COLOR='ORANGE' /  62.9 kW
+
+&HOLE XB=2.75,2.95,-0.10,0.15,0.00,1.83 / 2/6 Door
+
+&VENT XB=1.30,1.50,-0.10,0.10,0.00,0.00, SURF_ID='BURNER' / Position A
+&VENT XB=1.25,1.30,-0.05,0.05,0.00,0.00, SURF_ID='BURNER' /
+&VENT XB=1.50,1.55,-0.05,0.05,0.00,0.00, SURF_ID='BURNER' /
+&VENT XB=1.35,1.45,-0.15,-.10,0.00,0.00, SURF_ID='BURNER' /
+&VENT XB=1.35,1.45, 0.10,0.15,0.00,0.00, SURF_ID='BURNER' /
+
+&SURF ID='FIBER BOARD', DEFAULT=.TRUE., MATL_ID='INSULATION', THICKNESS=0.013, COLOR='BEIGE' /
+
+&REAC FUEL='METHANE',SOOT_YIELD=0. /
+
+&OBST XB=2.80,2.90,-1.40,1.40,0.00,2.13 / Wall with door or window
+
+&VENT MB='XMAX',SURF_ID='OPEN'/
+&VENT XB= 2.90,3.60,-1.40,-1.40,0.00,2.13, SURF_ID='OPEN'/
+&VENT XB= 2.90,3.60, 1.40, 1.40,0.00,2.13, SURF_ID='OPEN'/
+&VENT XB= 2.90,3.60,-1.40, 1.40,2.13,2.13, SURF_ID='OPEN'/
+
+&MATL ID            = 'INSULATION'
+      DENSITY       = 200.
+      CONDUCTIVITY  = 0.1
+      SPECIFIC_HEAT = 1. /
+
+
+&ISOF QUANTITY='TEMPERATURE', VALUE(1)=10., VALUE(2)=30., VALUE(3)=60. /
+&ISOF QUANTITY='U-VELOCITY' , VALUE(1)=0.08, QUANTITY2='TEMPERATURE' /
+
+&TAIL /

{fdsreader-1.10.2 → fdsreader-1.10.3}/examples/isof/isof_example.py

@@ -9,6 +9,8 @@ def main():
 
     vertices, triangles, _ = isosurface.to_global(len(isosurface.times) - 1)
 
+    print(triangles[-1][-1])
+    exit()
     # We ignore level 1 as it does not contain any vertices
     # level1 = isosurface.get_pyvista_mesh(vertices, triangles[0])
     level2 = isosurface.get_pyvista_mesh(vertices, triangles[1])

{fdsreader-1.10.2 → fdsreader-1.10.3}/examples/part/part_example.py

@@ -6,35 +6,32 @@ def main():
     sim = fds.Simulation("./fds_data")
 
     # Get all particles with specified id
-    particles = sim.particles["water droplets"]
+    particles = sim.particles["WATER PARTICLES"]
 
     # Get all data for the specified quantity
-    # quantity = "PARTICLE TEMPERATURE"
+    # quantity = "PARTICLE VELOCITY"
     quantity = "PARTICLE DIAMETER"
     color_data = particles.data[quantity]
-
     t_0 = next(i for i, pos in enumerate(particles.positions) if pos.shape[0] != 0)
 
     # Create PyVista animation
-    plotter = pv.Plotter()
+    plotter = pv.Plotter(notebook=False, off_screen=True)
     plotter.open_movie("anim.mp4")
 
     actor = plotter.add_mesh(pv.PolyData(particles.positions[t_0]), scalars=color_data[t_0],
                              render_points_as_spheres=True, point_size=15)
     plotter.add_scalar_bar(title=quantity)
-    plotter.show(auto_close=False)
-    plotter.write_frame()
+
+    # Open a gif
+    plotter.open_gif("particles.gif")
 
     for t in range(t_0 + 1, len(color_data)):
-        if particles.positions[t].shape[0] == 0:
-            continue
         plotter.remove_actor(actor)
         actor = plotter.add_mesh(pv.PolyData(particles.positions[t]), scalars=color_data[t],
                                  render_points_as_spheres=True, point_size=15)
-        plotter.remove_scalar_bar()
-        plotter.add_scalar_bar(title=quantity)
         plotter.write_frame()
 
+    # Closes and finalizes movie
     plotter.close()
 
 

{fdsreader-1.10.2 → fdsreader-1.10.3}/examples/slcf/fds_steckler/input_steckler.fds

@@ -3,7 +3,7 @@
 &MESH IJK=36,28,22, XB=0.00,3.60,-1.40,1.40,0.00,2.13 /
 
 &TIME T_END=100.0, TIME_SHRINK_FACTOR=10. /
-&DUMP NFRAMES=100, DT_DEVC=10., DT_DEVC_LINE=10., DT_HRR=10., SIG_FIGS=4, SIG_FIGS_EXP=2 /
+&DUMP NFRAMES=100, DT_DEVC=10., DT_HRR=10., SIG_FIGS=4, SIG_FIGS_EXP=2 /
 
 &MISC TMPA=22. /
 

{fdsreader-1.10.2 → fdsreader-1.10.3}/fdsreader/_version.py

@@ -7,5 +7,5 @@ Provides fdsreader version information.
 
 from incremental import Version
 
-__version__ = Version("fdsreader", 1, 10, 2)
+__version__ = Version("fdsreader", 1, 10, 3)
 __all__ = ["__version__"]

{fdsreader-1.10.2 → fdsreader-1.10.3}/fdsreader/evac/evac_collection.py

@@ -12,7 +12,8 @@ from fdsreader import settings
 
 class EvacCollection(FDSDataCollection):
     """Collection of :class:`Evacuation` objects. Next to agent-class specific data (such as
-        trajectories) lots of other data such as FED-data is provided via this class.
+        trajectories) lots of other data such as FED-data is provided via this class.  
+        Note: Evac support was removed from FDS in all versions after 6.7.7!
 
         :ivar times: List of all time steps of the simulation.
         :ivar z_offsets: The offset in z-direction for each mesh where the evac plane lays.

{fdsreader-1.10.2 → fdsreader-1.10.3}/fdsreader/evac/evacuation.py

@@ -39,6 +39,7 @@ from fdsreader.utils import Quantity
 
 class Evacuation:
     """Container to store evac data from evac simulations with FDS.
+        Note: Evac support was removed from FDS in all versions after 6.7.7!
 
     :ivar class_name: Name of the evac class defined in the FDS input-file.
     :ivar quantities: List of all quantities for which data has been written out.

{fdsreader-1.10.2 → fdsreader-1.10.3}/fdsreader/part/particle_collection.py

@@ -9,8 +9,7 @@ from fdsreader import settings
 
 
 class ParticleCollection(FDSDataCollection):
-    """Collection of :class:`Plot3D` objects. Offers extensive functionality for filtering and
-        using plot3Ds as well as its subclasses such as :class:`SubPlot3D`.
+    """Collection of :class:`Particle` objects.
     """
 
     def __init__(self, times: Iterable[float], particles: Iterable[Particle]):
@@ -83,19 +82,18 @@ class ParticleCollection(FDSDataCollection):
 
                         # Read tags
                         dtype_tags = fdtype.new((('i', n_particles),))
-                        particle._tags[t][offset: offset + n_particles] = \
-                            fdtype.read(infile, dtype_tags, 1)[0][0]
+                        particle._tags[t][offset: offset + n_particles] = fdtype.read(infile, dtype_tags, 1)[0][0]
 
                         # Read actual quantity values
                         if len(particle.quantities) > 0:
                             dtype_data = fdtype.new(
-                                (('f', str((n_particles, len(particle.quantities)))),))
+                                (('f', str((len(particle.quantities), n_particles))),))
                             data_raw = fdtype.read(infile, dtype_data, 1)[0][0].reshape(
-                                (n_particles, len(particle.quantities)), order='F')
+                                (len(particle.quantities), n_particles), order='F')
 
                             for q, quantity in enumerate(particle.quantities):
                                 particle._data[quantity.name][t][
-                                offset:offset + n_particles] = data_raw[:, q].astype(float)
+                                offset:offset + n_particles] = data_raw[q, :].astype(float)
 
                         pointer_location[particle][t] += particle.n_particles[mesh][t]
 

{fdsreader-1.10.2 → fdsreader-1.10.3}/fdsreader.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fdsreader
-Version: 1.10.2
+Version: 1.10.3
 Summary: Python reader for data generated by FDS.
 Home-page: https://github.com/FireDynamics/fdsreader
 Author: FZJ IAS-7 (Jan Vogelsang, Prof. Dr. Lukas Arnold, Tristan Hehnen)
@@ -89,7 +89,7 @@ It is also possible to deploy to PyPI and Github pages manually using the follow
 3. sphinx-build -b html docs docs/build
 4. cd .. && mkdir gh-pages && cd gh-pages
 5. git init && git remote add origin git@github.com:FireDynamics/fdsreader.git
-6. git fetch --all
+6. git fetch origin gh-pages:gh-pages
 7. git checkout gh-pages
 8. cp -r ../fdsreader/docs/build/* .
 9. git add . && git commit -m "..." && git push origin HEAD:gh-pages

{fdsreader-1.10.2 → fdsreader-1.10.3}/fdsreader.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+.gitattributes
 .gitignore
 .travis.yml
 Dockerfile
@@ -6,8 +7,12 @@ MANIFEST.in
 README.md
 RELEASE.md
 docker_deployment.sh
+paper.bib
+paper.md
 requirements.txt
 setup.py
+.github/workflows/joss.yml
+.github/workflows/testsuite.yml
 docs/bndf.rst
 docs/conf.py
 docs/devc.rst
@@ -44,7 +49,6 @@ examples/geom/fds_geomslices/PWB01_GEOM.fds
 examples/isof/isof_example.py
 examples/isof/fds_steckler/input_steckler.fds
 examples/part/part_example.py
-examples/part/fds_data/impact.fds
 examples/pl3d/pl3d_example.py
 examples/pl3d/fds_data/vort3d_80.fds
 examples/slcf/slcf_example_global.py
@@ -109,5 +113,19 @@ fdsreader/utils/dimension.py
 fdsreader/utils/extent.py
 fdsreader/utils/fortran_data.py
 fdsreader/utils/misc.py
-tests/test.py
-tests/test.smv
+tests/test.smv
+tests/test_version_compatibility.py
+tests/acceptance_tests/test_bndf.py
+tests/acceptance_tests/test_devc.py
+tests/acceptance_tests/test_geom.py
+tests/acceptance_tests/test_isof.py
+tests/acceptance_tests/test_part.py
+tests/acceptance_tests/test_pl3d.py
+tests/acceptance_tests/test_slcf.py
+tests/acceptance_tests/test_smoke3d.py
+tests/cases/bndf_data.tgz
+tests/cases/devc_data.tgz
+tests/cases/geom_data.tgz
+tests/cases/part_data.tgz
+tests/cases/pl3d_data.tgz
+tests/cases/steckler_data.tgz

fdsreader-1.10.3/paper.bib

@@ -0,0 +1,18 @@
+@misc{FDS,
+  author = {Kevin McGrattan and Randall McDermott and Craig Weinschenk and Glenn Forney},
+  title = {Fire Dynamics Simulator Users Guide, Sixth Edition},
+  year = {2013},
+  month = {2013-11-04},
+  publisher = {Special Publication (NIST SP), National Institute of Standards and Technology, Gaithersburg, MD},
+  doi = {https://doi.org/10.6028/NIST.sp.1019},
+  language = {en},
+}
+
+@misc{SMV,
+  author = {Glenn Forney},
+  title = {Smokeview (Version 5) - A Tool for Visualizing Fire Dynamics Simulation Data, Volume I: User's Guide},
+  year = {2017},
+  month = {2017-02-19 20:02:57},
+  publisher = {Special Publication (NIST SP), National Institute of Standards and Technology, Gaithersburg, MD},
+  language = {en},
+}

fdsreader-1.10.3/paper.md

@@ -0,0 +1,64 @@
+---
+title: 'FDSReader'
+tags:
+  - Python
+  - TODO
+authors:
+  - name: Jan Niklas Vogelsang
+    orcid: 0000-0003-2336-6630
+    affiliation: 1
+  - name: Prof. Dr. Lukas Arnold
+    orcid: TODO
+    affiliation: 2
+affiliations:
+  - name: PGI-15, Forschungszentrum Jülich, Germany
+    index: 1
+  - name: IAS-7, Forschungszentrum Jülich, Germany
+    index: 2
+date: 15 March 2024
+bibliography: paper.bib
+---
+
+# Summary
+
+In recent years, Python has become the most popular programming language in the scientific community. It offers
+extensive functionality for preparing, post-processing and visualising data of all types and origins. By
+a large number of freely available packages, the programming environment can be flexibly adapted to your own
+needs. However, until now it was not possible to automatically import and process fire simulation data as
+produced by the fire dynamics simulator (FDS) [@FDS] for example. Using SmokeView [@SMV], it was
+already possible to visualize generated data, but it was not possible to process it directly or perform detailed
+analysis on the data itself. The introduction of the fdsreader made this possible in an uncomplicated and efficient way.
+
+# Statement of need
+
+Up until now, most working groups in both industry and research have had no solution for efficiently and
+automatically reading the binary data output by FDS to process it further. One would either have to use Fds2Ascii, a
+Fortran program to manually convert the binary output of FDS into a text file and read in the text file with their
+preferred language or write their own scripts to read the binary data output of FDS and further process the data. Many
+groups did end up with their own set of, typically Python-based, scripts to read the various types of data an FDS
+simulation can produce, e.g. slices, boundary data, etc.
+As the internal data structures of FDS are non-trivial and the source code is not trivial to understand for an outsider,
+the scripts usually require lots of time to write, ended up having strict limitations to the simulation parameters,
+e.g. only  single mesh based simulations, and could not process all types of data. In addition, new versions of FDS
+often meant that some scripts no longer worked as expected, requiring even more time investment to maintain these scripts.
+The fdsreader Python package provides functionality to automatically import the full set of FDS outputs for both old and
+new versions of FDS.
+When first loading a simulation, all metadata is collected and cached to reduce subsequent load times. The actual
+data produced during the simulation such as the slice data for each time step, is not loaded until the data is accessed by the
+user via Python, which then triggers loading the data into memory in the background and converting it to equivalent
+Python datastructures. This method minimizes initial loading time without sacrificing the ability to easily filter and
+select the desired data. The fdsreader collects all data of the same type into one collection and offers its own set
+functions for each type to easily select the data which should be further processed. These functions can even be called
+in an automated fashion, to run some predefined postprocessing routines on simulation data without having to manually
+interact with the data, as one would have to do when using SmokeView or Fds2Ascii.
+The fdsreader is able to read all data types available in FDS including most of the additional metadata. To be concrete,
+the package contains modules for slices (slcf), boundary data (bndf), volumes (plot3d, smoke3d) particles (part),
+isosurfaces (isof), evacuations (evac), complex geometry boundary data (geom), devices (devc) and meshes. Slices,
+boundary data, isosurfaces and volumes are each respectively seperated into multiple parts, one for each mesh. While FDS
+outputs the data separately for each mesh, the fdsreader provides methods to combine all these parts automatically and
+operate on data across meshes.
+
+# Acknowledgements
+TODO
+
+# References

fdsreader-1.10.3/tests/acceptance_tests/test_bndf.py

@@ -0,0 +1,9 @@
+from fdsreader import Simulation
+
+
+def test_bndf():
+    sim = Simulation("./bndf_data")
+    obst = sim.obstructions.get_nearest(-0.8, 1, 1)
+    face = obst.get_global_boundary_data_arrays("Wall Temperature")[1]
+
+    assert len(face[-1]) == 68

fdsreader-1.10.3/tests/acceptance_tests/test_devc.py

@@ -0,0 +1,6 @@
+from fdsreader import Simulation
+
+
+def test_devc():
+    sim = Simulation("./steckler_data")
+    assert abs(sim.devices["TC_Door"][0].data - 23.58) < 1e-6

fdsreader-1.10.3/tests/acceptance_tests/test_geom.py

@@ -0,0 +1,9 @@
+from fdsreader import Simulation
+
+
+def test_geom():
+    sim = Simulation("./geom_data")
+    geom = sim.geom_data.filter_by_quantity("Radiative Heat Flux")[0]
+
+    assert len(geom.faces) == len(geom.data[-1]) == 19816
+    assert len(geom.vertices) == 40624

fdsreader-1.10.3/tests/acceptance_tests/test_isof.py

@@ -0,0 +1,10 @@
+from fdsreader import Simulation
+
+
+def test_isof():
+    sim = Simulation("./steckler_data")
+    isosurface = sim.isosurfaces.filter_by_quantity("TEMP")[0]
+    vertices, triangles, _ = isosurface.to_global(len(isosurface.times) - 1)
+
+    assert abs(vertices[-1][0] - 2.80595016) < 1e-6 and abs(vertices[-1][1] - 0.1) < 1e-6 and abs(vertices[-1][2] - 1.83954549) < 1e-6
+    assert abs(triangles[-1][-1][0] - 4625) < 1e-6 and abs(triangles[-1][-1][1] - 4627) < 1e-6 and abs(triangles[-1][-1][2] - 4708) < 1e-6

fdsreader-1.10.3/tests/acceptance_tests/test_part.py

@@ -0,0 +1,11 @@
+from fdsreader import Simulation
+
+
+def test_part():
+    sim = Simulation("./part_data")
+    particles = sim.particles["WATER PARTICLES"]
+    position = particles.positions[-1][-1]
+    color_data = particles.data["PARTICLE DIAMETER"]
+
+    assert abs(position[0] + 0.04036335) < 1e-6 and abs(position[1] - 0.05389348) < 1e-6 and abs(position[2] - 13.596354) < 1e-6
+    assert abs(color_data[-1][-1] - 321.1149902) < 1e-6

fdsreader-1.10.3/tests/acceptance_tests/test_pl3d.py

@@ -0,0 +1,10 @@
+from fdsreader import Simulation
+
+
+def test_pl3d():
+    sim = Simulation("./pl3d_data")
+    pl_t1 = sim.data_3d.get_by_quantity("Temperature")
+    data, coordinates = pl_t1.to_global(masked=True, return_coordinates=True)
+
+    assert abs(data[-1, 41, 27, 0] - 55.85966110229492) < 1e-6
+    assert abs(coordinates['x'][41] - 9.25) < 1e-6

fdsreader-1.10.3/tests/acceptance_tests/test_slcf.py

@@ -0,0 +1,8 @@
+from fdsreader import Simulation
+
+
+def test_slcf():
+    sim = Simulation("./steckler_data")
+    data, coordinates = sim.slices[0].to_global(masked=True, return_coordinates=True)
+    assert abs(data[-1, -1, -1] - 33.311744689941406) < 1e-6
+    assert abs(coordinates['x'][0] - 0.) < 1e-6 and abs(coordinates['x'][-1] - 3.6) < 1e-6

fdsreader-1.10.3/tests/acceptance_tests/test_smoke3d.py

@@ -0,0 +1,10 @@
+from fdsreader import Simulation
+
+
+def test_smoke3d():
+    sim = Simulation("./steckler_data")
+    smoke = sim.smoke_3d.get_by_quantity("Temperature")
+    data, coordinates = smoke.to_global(masked=True, return_coordinates=True)
+
+    assert abs(data[-1, 13, 13, 1] - 77.) < 1e-6
+    assert abs(coordinates['x'][13] - 1.3) < 1e-6