Skip to content

README.md

Latest commit

 

History

History
88 lines (60 loc) · 2.9 KB

README.md

File metadata and controls

88 lines (60 loc) · 2.9 KB

FlameTrack

Release Quality Documentation
PyPI Latest Release CI Status Documentation Status
PyPI - Python Version codecov DOI
License linting: pylint

FlameTrack is a Python application for analyzing flame spread experiments, including room corner tests and lateral flame spread tests. It offers an intuitive graphical user interface (GUI) for:

  • Image Dewarping – correcting perspective distortions for different setups.
  • Flame Edge Tracking – detecting and following the flame front over time.
  • Data Export – saving processed images, metadata, and measurements for further analysis.

Designed for research environments, FlameTrack combines precision with ease of use.

Features

  • Two experiment modes – Room Corner and Lateral Flame Spread, with tailored workflows.
  • Point-based calibration for accurate dewarping.
  • Dynamic edge detection with adjustable thresholds.
  • Structured result storage in HDF5 format.

Installation

The easiest way to install FlameTrack is from PyPI:

pip install flametrack

For updates:

pip install --upgrade flametrack

Usage

Start the application

flametrack

(or)

python -m flametrack

Typical workflow

  1. Select experiment type – Room Corner or Lateral Spread.
  2. Load your experimental data – images.
  3. Mark reference points – for dewarping calibration.
  4. Run dewarping – to obtain corrected images.
  5. Start flame edge tracking – extract flame position over time.

Development installation

If you want to contribute or run FlameTrack from source:

git clone https://github.com/FireDynamics/FlameTrack.git
cd FlameTrack
pip install -e .

Contributing

Contributions are welcome – whether it’s bug reports, feature suggestions, or code improvements. Please open an issue or submit a pull request on GitHub.

License

See the LICENSE file for details.