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
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()'
- Install
- (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
- (Option 3) Installing from source in edit mode. The advantage of this mode is python will import modules from the source directly. This allows you to modify scripts as needed or update with a git pull.
- Navigate to desired installation location
- Clone the repository
git clone https://github.com/johodges/pyfdstools - Install with pip
pip install -e pyfdstools/ - Run the example cases
cd pyfdstools python pyfdstools/examples.py
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.