Welcome to the FlameTrack Documentation
=======================================

FlameTrack is a desktop application for analysing fire spread from infrared
and visible-light recordings. It corrects perspective distortion
(*dewarping*), detects the flame edge frame-by-frame, and stores all results
in a documented HDF5 file ready for further analysis.

**Typical workflow**

1. Point FlameTrack at your experiment folder (see :doc:`user_guide/configuration`)
2. Load a recording and place calibration points on the specimen corners
3. Run **Dewarp** → Run **Find Edge**
4. Open the resulting ``.h5`` file in Python, MATLAB, or any HDF5 viewer

New here? Start with the :doc:`user_guide/quickstart`.

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   user_guide/index

.. toctree::
   :maxdepth: 2
   :caption: Developer Guide

   developer_guide/index