Skip to content

RIO4FDS/pyfdstools

 
 

Repository files navigation

python-fds-tools

A Python Package to Assist in Developing and Post-Processing Data Produced Through the Computational Fluid Dynamics Software Fire Dynamics Simulator.

This software is part of a python library to assist in developing and analyzing simulation results from Fire Dynamics Simulator (FDS). FDS is an open source computational fluid dynamics (CFD) software package developed by NIST. The sourcecode is available at: https://github.com/firemodels/fds

Installation

This module was developed for use in a virtual environment. The package can be installed through pip or source.

  • Configuring the virtual environment
    python -m venv c:\path\to\myenv
    
  • Activate the virtual environment
    source c:\path\to\myenv\Scripts\activate
    
  • (Option 1) Installing via pip
    • Install
      python -m pip install pyfdstools
      
    • Run the example cases
      python -c 'import pyfdstools as fds; fds.runExamples()'
      
  • (Option 2) Installing from source
    • Navigate to desired installation location
    • Clone the repository
      git clone https://github.com/johodges/pyfdstools
      
    • Install with pip
      pip install pyfdstools/
      
    • Run the example cases
      cd pyfdstools
      python pyfdstools/examples.py
      

Citation

If you use this software in your research, please consider citing this project as:

Hodges, J. L., pyFDStools: A Python Package to Assist in Developing and Post-Processing Data Produced Through the Computational Fluid Dynamics Software Fire Dynamics Simulator, (2020), GitHub repository, https://github.com/johodges/pyfdstools.

About

A Python Package to Assist in Developing and Post-Processing Data Produced Through the Computational Fluid Dynamics Software Fire Dynamics Simulator.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 100.0%