Installation¶
Quick option:
Pre-built binaries for Windows, macOS, and Linux are available on the GitHub Releases page. Download the latest release for your platform and run the executable—no installation required.
Requirements¶
- Python 3.9 or later
- PyQt6
- Other dependencies (see
Tool/requirements.txt)
Steps (from source)¶
Note: The PyQt GUI project lives in the
Tool/subdirectory of this repository. All commands below assume you are running them from the repository root unless stated otherwise.
-
Clone the repository
-
(Recommended) Create and activate a Conda environment
-
Install dependencies: The main dependencies are:
- pyqt6
- opencv-python (optional, for video rendering/computer vision)
- See
requirements.txtfor the full list
Install with pip:
-
Run the tool:
Troubleshooting¶
- If you have issues with Qt or video playback, check Troubleshooting.