Metadata-Version: 2.1
Name: fdsreader
Version: 0.4.3
Summary: Python reader for data generated by FDS.
Home-page: https://github.com/JanVogelsang/fdsreader
Author: FZJ IAS-7 (Prof. Dr. Lukas Arnold, Jan Vogelsang)
Author-email: j.vogelsang@fz-juelich.de
License: UNKNOWN
Description: # FDSReader
        > Python reader for FDS data
        
        [![Build Status](https://travis-ci.org/JanVogelsang/fdsreader.svg?branch=master)](https://travis-ci.org/JanVogelsang/fdsreader)
        
        [One to two paragraph statement about the fdsreader.]
        
        ![](https://via.placeholder.com/250)
        
        ## Installation
        
        The package is available on PyPI and can be installed using pip:  
        ```sh
        python -m pip install --upgrade fdsreader
        ```
        
        ## Usage example
        ```python
        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/](https://janvogelsang.github.io/fdsreader/)
        
        ## Release History
        * 1.0.0
            * (First official version will be released after sufficient public testing in beta stage)
        ### Beta
        * 0.9.0
            * (Entering beta status after extensive testing with selected participants in alpha stage)
        ### Alpha
        * 0.x.0
            * (Entering alpha status after extensive private testing in pre-alpha stage)
        ### Pre-Alpha
        * 0.4.2
            * (Coming soon...)
        * 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 – j.vogelsang@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/JanVogelsang/fdsreader](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
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
