fdsreader 1.3.12__tar.gz → 1.7.1__tar.gz

{fdsreader-1.3.12 → fdsreader-1.7.1}/PKG-INFO

@@ -1,12 +1,10 @@
 Metadata-Version: 2.1
 Name: fdsreader
-Version: 1.3.12
+Version: 1.7.1
 Summary: Python reader for data generated by FDS.
 Home-page: https://github.com/FireDynamics/fdsreader
 Author: FZJ IAS-7 (Prof. Dr. Lukas Arnold, Jan Vogelsang)
 Author-email: j.vogelsang@fz-juelich.de
-License: UNKNOWN
-Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
 Classifier: Operating System :: OS Independent
@@ -17,7 +15,6 @@ License-File: LICENSE
 # FDSReader
 > Fast and easy-to-use Python reader for FDS data
 
-[![Build Status](https://travis-ci.com/FireDynamics/fdsreader.svg?branch=master)](https://travis-ci.com/FireDynamics/fdsreader)  
 [![PyPI version](https://badge.fury.io/py/fdsreader.png)](https://badge.fury.io/py/fdsreader)  
 
 
@@ -67,6 +64,19 @@ documentation of all classes check the API Documentation below.
 ## API Documentation
 [https://firedynamics.github.io/fdsreader/](https://firedynamics.github.io/fdsreader/)
 
+## Deployment
+As the fdsreader has come a long way and the free capabilities of Travis CI have been used up, we now moved to manual CI/CD using a local docker container.  
+First, the Dockerfile has to be modified to make authentication to GitHub and PyPI possible from within the container.
+To do so generate these two tokens:  
+PyPI: https://pypi.org/manage/account/token/  
+GitHub: https://github.com/settings/tokens/new (set the repo_deployment and public_repo scopes)  
+Now add these Tokens in the Dockerfile. To now deploy the fdsreader to PyPI and update the Github Pages (Documentation), run the following commands after pushing your changes to the FDSReader to GitHub (apart from the Dockerfile).
+```bash
+cd $REPO_ROOT_DIR
+docker build . -t fdsreader-ci  # Only needed the very first time
+docker run --rm fdsreader-ci
+```
+
 ## Meta
 
 *  Jan Vogelsang – j.vogelsang@fz-juelich.de
@@ -83,5 +93,3 @@ Distributed under the LGPLv3 (GNU Lesser General Public License v3) license. See
 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
-
-

{fdsreader-1.3.12 → fdsreader-1.7.1}/README.md

@@ -1,7 +1,6 @@
 # FDSReader
 > Fast and easy-to-use Python reader for FDS data
 
-[![Build Status](https://travis-ci.com/FireDynamics/fdsreader.svg?branch=master)](https://travis-ci.com/FireDynamics/fdsreader)  
 [![PyPI version](https://badge.fury.io/py/fdsreader.png)](https://badge.fury.io/py/fdsreader)  
 
 
@@ -51,6 +50,19 @@ documentation of all classes check the API Documentation below.
 ## API Documentation
 [https://firedynamics.github.io/fdsreader/](https://firedynamics.github.io/fdsreader/)
 
+## Deployment
+As the fdsreader has come a long way and the free capabilities of Travis CI have been used up, we now moved to manual CI/CD using a local docker container.  
+First, the Dockerfile has to be modified to make authentication to GitHub and PyPI possible from within the container.
+To do so generate these two tokens:  
+PyPI: https://pypi.org/manage/account/token/  
+GitHub: https://github.com/settings/tokens/new (set the repo_deployment and public_repo scopes)  
+Now add these Tokens in the Dockerfile. To now deploy the fdsreader to PyPI and update the Github Pages (Documentation), run the following commands after pushing your changes to the FDSReader to GitHub (apart from the Dockerfile).
+```bash
+cd $REPO_ROOT_DIR
+docker build . -t fdsreader-ci  # Only needed the very first time
+docker run --rm fdsreader-ci
+```
+
 ## Meta
 
 *  Jan Vogelsang – j.vogelsang@fz-juelich.de

{fdsreader-1.3.12 → fdsreader-1.7.1}/fdsreader/_version.py

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

{fdsreader-1.3.12 → fdsreader-1.7.1}/fdsreader/evac/EvacCollection.py

@@ -27,7 +27,7 @@ class EvacCollection(FDSDataCollection):
         :ivar target_door_counters: Target door counts per time step.
     """
 
-    def __init__(self, evacs: Iterable[Evacuation], base_path: str):
+    def __init__(self, evacs: Iterable[Evacuation], base_path: str, times: Iterable[float]):
         super().__init__(evacs)
 
         self._file_paths: Dict[Mesh, str] = dict()
@@ -36,6 +36,8 @@ class EvacCollection(FDSDataCollection):
 
         self._load_csv_data()
 
+        self.times = times
+
         for evac in evacs:
             evac.times = self.times
 
@@ -104,6 +106,7 @@ class EvacCollection(FDSDataCollection):
 
         if not os.path.exists(file_path):
             self._xyz = np.array([])
+            self._load_fed_data(0)
             return
 
         with open(file_path, 'rb') as infile:

{fdsreader-1.3.12 → fdsreader-1.7.1}/fdsreader/export/__init__.py

@@ -1,3 +1,4 @@
 from .smoke3d_exporter import export_smoke_raw
 from .slcf_exporter import export_slcf_raw
 from .obst_exporter import export_obst_raw
+from .sim_exporter import export_sim

{fdsreader-1.3.12 → fdsreader-1.7.1}/fdsreader/export/obst_exporter.py

@@ -16,7 +16,7 @@ def export_obst_raw(obst: Obstruction, output_dir: str, ordering: Literal['C', '
     :param ordering: Whether to write the data in C or Fortran ordering.
     """
     if len(obst.quantities) == 0:
-        return
+        return ""
 
     from pathos.pools import ProcessPool as Pool
     from multiprocess import Lock, Manager
@@ -117,6 +117,9 @@ def export_obst_raw(obst: Obstruction, output_dir: str, ordering: Literal['C', '
 
     meta["Quantities"] = list(meta["Quantities"])
 
-    with open(os.path.join(output_dir, obst_filename_base + ".yaml"), 'w') as metafile:
+    meta_file_path = os.path.join(output_dir, obst_filename_base + ".yaml")
+    with open(meta_file_path, 'w') as meta_file:
         import yaml
-        yaml.dump(meta, metafile)
+        yaml.dump(meta, meta_file)
+
+    return meta_file_path

fdsreader-1.7.1/fdsreader/export/sim_exporter.py

@@ -0,0 +1,40 @@
+import os
+from typing_extensions import Literal
+from . import export_slcf_raw, export_obst_raw, export_smoke_raw
+from .. import Simulation
+
+
+def export_sim(sim: Simulation, output_dir: str, ordering: Literal['C', 'F'] = 'C'):
+    """Exports the 3d arrays to raw binary files with corresponding .yaml meta files.
+
+    :param sim: The :class:`Simulation` to export.
+    :param output_dir: The directory in which to save all files.
+    :param ordering: Whether to write the data in C or Fortran ordering.
+    """
+    meta = {"Obstructions": list(), "Slices": list(), "Volumes": list(), "Hash": sim._hash}
+
+    for obst in sim.obstructions:
+        obst_path = export_obst_raw(obst, os.path.join(output_dir, "obst"), ordering)
+        if obst_path:
+            meta["Obstructions"].append(os.path.relpath(obst_path, output_dir).replace("\\", "/"))
+
+    for slc in sim.slices:
+        slice_path = export_slcf_raw(slc, os.path.join(output_dir, "slices", slc.quantity.name.replace(' ', '_').lower()), ordering)
+        if slice_path:
+            meta["Slices"].append(os.path.relpath(slice_path, output_dir).replace("\\", "/"))
+
+    for smoke in sim.smoke_3d:
+        volume_path = export_smoke_raw(smoke, os.path.join(output_dir, "smoke", smoke.quantity.name.replace(' ', '_').lower()), ordering)
+        if volume_path:
+            meta["Volumes"].append(os.path.relpath(volume_path, output_dir).replace("\\", "/"))
+
+    meta["NumObstructions"] = len(meta["Obstructions"])
+    meta["NumSlices"] = len(meta["Slices"])
+    meta["NumVolumes"] = len(meta["Volumes"])
+
+    import yaml
+    meta_file_path = os.path.join(output_dir, sim.chid + "-smv.yaml")
+    with open(meta_file_path, 'w') as metafile:
+        yaml.dump(meta, metafile)
+
+    return meta_file_path

{fdsreader-1.3.12 → fdsreader-1.7.1}/fdsreader/export/slcf_exporter.py

@@ -15,7 +15,7 @@ def export_slcf_raw(slc: Slice, output_dir: str, ordering: Literal['C', 'F'] = '
     from pathos.pools import ProcessPool as Pool
     from multiprocess import Lock, Manager
     slc2d = slc.type == '2D'
-    meta = {"DataValMax": float(slc.vmax), "DataValMin": float(slc.vmin), "ScaleFactor": 255. / (float(slc.vmax) - float(slc.vmin)),
+    meta = {"CellCentered": 1 if slc.cell_centered else 0, "DataValMax": float(slc.vmax), "DataValMin": float(slc.vmin), "ScaleFactor": 255. / (float(slc.vmax) - float(slc.vmin)),
             "MeshNum": len(slc.subslices), "Quantity": slc.quantity.name}
 
     filename_base = ("slice" + ("2D-" if slc2d else "3D-") + slc.id.lower()).replace(" ", "_").replace(".", "-")
@@ -49,18 +49,19 @@ def export_slcf_raw(slc: Slice, output_dir: str, ordering: Literal['C', 'F'] = '
             meta["Meshes"].append({
                 "Mesh": mesh_id,
                 "DataFile": os.path.join(filename_base + "-data", filename),
-                "MeshPos": f"{mesh.coordinates['x'][0]:.6} {mesh.coordinates['y'][0]:.6} {mesh.coordinates['z'][0]:.6}",
+                "MeshPos": f"{subslice.extent['x'][0]:.6} {subslice.extent['y'][0]:.6} {subslice.extent['z'][0]:.6}",
                 "Spacing": f"{spacing[0]:.6} {spacing[1]:.6} {spacing[2]:.6} {spacing[3]:.6}",
                 "DimSize": f"{shape[0]} {shape[1]} {shape[2]} {shape[3]}"
             })
 
-    pool = Pool(8)
-    pool.map(lambda args: worker(*args), list(slc._subslices.items()))
-    pool.close()
-    pool.join()
+    with Pool() as pool:
+        pool.map(lambda args: worker(*args), list(slc._subslices.items()))
 
     meta["Meshes"] = list(meta["Meshes"])
 
-    with open(os.path.join(output_dir, filename_base + ".yaml"), 'w') as metafile:
+    meta_file_path = os.path.join(output_dir, filename_base + ".yaml")
+    with open(meta_file_path, 'w') as meta_file:
         import yaml
-        yaml.dump(meta, metafile)
+        yaml.dump(meta, meta_file)
+
+    return meta_file_path

{fdsreader-1.3.12 → fdsreader-1.7.1}/fdsreader/export/smoke3d_exporter.py

@@ -26,11 +26,12 @@ def export_smoke_raw(smoke3d: Smoke3D, output_dir: str, ordering: Literal['C', '
         meta["DataValMin"] = min(meta["DataValMin"], np.min(subsmoke.data))
     meta["DataValMax"] = float(meta["DataValMax"])
     meta["DataValMin"] = float(meta["DataValMin"])
-    meta["ScaleFactor"] = 255.0 / meta["DataValMax"]
 
     # Abort if no useful data is available
     if meta["DataValMax"] <= 0:
-        return
+        return ""
+
+    meta["ScaleFactor"] = 255.0 / meta["DataValMax"]
 
     m = Manager()
     meta["Meshes"] = m.list()
@@ -61,13 +62,14 @@ def export_smoke_raw(smoke3d: Smoke3D, output_dir: str, ordering: Literal['C', '
                 "DimSize": f"{data.shape[0]} {data.shape[1]} {data.shape[2]} {data.shape[3]}"
             })
 
-    pool = Pool(8)
-    pool.map(lambda args: worker(*args), list(smoke3d._subsmokes.items()))
-    pool.close()
-    pool.join()
+    with Pool() as pool:
+        pool.map(lambda args: worker(*args), list(smoke3d._subsmokes.items()))
 
     meta["Meshes"] = list(meta["Meshes"])
 
-    with open(os.path.join(output_dir, filename_base + ".yaml"), 'w') as metafile:
+    meta_file_path = os.path.join(output_dir, filename_base + ".yaml")
+    with open(meta_file_path, 'w') as meta_file:
         import yaml
-        yaml.dump(meta, metafile)
+        yaml.dump(meta, meta_file)
+
+    return meta_file_path

{fdsreader-1.3.12 → fdsreader-1.7.1}/fdsreader/fds_classes/mesh.py

@@ -65,7 +65,7 @@ class Mesh:
         """Marks all cells of a single slice which are blocked by an obstruction.
 
         :returns: A 4-dimensional array with time as first and x,y,z as last dimensions. The array depends on time as
-            as obstructions may be hidden as specific points in time.
+            obstructions may be hidden as specific points in time.
         """
         orientation = subslice.orientation
         value = subslice.extent[orientation][0]

{fdsreader-1.3.12 → fdsreader-1.7.1}/fdsreader/fds_classes/surface.py

@@ -2,8 +2,8 @@ from typing import Optional, Tuple
 
 
 class Surface:
-    """Surface objects describe what bounding surfaces consist of. Boundary conditions for
-        obstructions and vents are prescribed by referencing the appropriate surface.
+    """Surface objects describe what bounding surfaces consist of. Boundary conditions for obstructions and vents are
+        prescribed by referencing the appropriate surface.
 
     :ivar name: Name of the surface.
     :ivar material_emissivity: Emissivity of the material.

{fdsreader-1.3.12 → fdsreader-1.7.1}/fdsreader/settings.py

@@ -4,6 +4,8 @@ ENABLE_CACHING = True
 
 DEBUG = False
 
+IGNORE_ERRORS = False
+
 # As the binary representation of raw data is compiler dependent, this information must be provided
 # by the user
 FORTRAN_DATA_TYPE_INTEGER = "<i4"  # <i4 -> 4-byte integer (little-endian)