Folder Map and Design

run.bat / run.sh        launchers (Windows / Linux + macOS): fetch a private Python if the
                        computer has none, create .venv, install, verify, start; --check = report only
Kinetrace.command       macOS double-click launcher (opens Terminal and runs run.sh)
Kinetrace.lnk           Windows shortcut run.bat makes (kinetrace/winapp.py): the folder's pythonw runs
                        kinetrace/winlaunch.py -- the app with no console, or run.bat when a setup
                        step is due; Help -> Add Kinetrace to the Start Menu copies it (opt-in)
update.bat / update.sh / Update.command   update to the newest published version with the app
                        closed (the same as Help -> Check for Updates)
install.py              installs PyTorch for this machine, then requirements.txt; verifies every
                        import; writes .venv/kinetrace-install.json; prints the system check
requirements.txt        the other dependencies
kinetrace/          the application (calib.py / hull.py / view3d.py = the 3D layer;
                        device.py = which processor the models run on and what that switches off;
                        update.py / updatedialog.py = Help -> About and Check for Updates;
                        downloads.py = every model download, pinned to a commit and checked;
                        errors.py = errors in words for the user;
                        spots.py / pointtest.py = the Moving spot point model and the
                        test that picks a point model from the user's clicks;
                        appicon.py = the app icon, drawn in code: a viewfinder, three tracked trails)
.github/workflows/      install-check.yml (install on every OS, by hand) and release.yml
                        (publishes a release when APP_VERSION changes on main)
docs/                   the user manual (also in the app, F1) and the developer handbook
tests/                  verification suites and audit tools (tests/out/ is scratch)
tools/                  developer tools (a decode benchmark)
make_test_video.py      synthetic test videos with ground truth
LICENSE.md              Kinetrace's own licence (PolyForm Noncommercial 1.0.0)
LICENSES/, THIRD_PARTY_LICENSES.md   licences of everything Kinetrace uses
created on your computer (never in the repository):
  .venv/                all Python dependencies (.venv/base = the private Python, when the
                        computer had none of its own)
  models/               the point, segmentation and body models
  skeletons/            your own skeleton templates (JSON)
  logs/                 the error log (kinetrace.log, kinetrace-crash.log; Help -> Error Report)
  .kinetrace-release.json   the files the installed release put here (a ZIP install, after an update)

A project is a folder of its own, name.kinetrace/ (wherever you save it): kinetrace.json, README.txt, project.json, one cameras/<camera>/ folder each (its landmarks in tracks/<landmark>.csv), exports/ (files for other programs, when chosen), videos/ (optional), and the program's .cache/ (fast opening) and .history/ (the previous save). See Projects & autosave.

Appearance

The app uses a quiet, dark, content-first design: the video is the hero, controls stay out of the way, and one blue accent consistently means "active / selected / primary" — the filled Track button, checked tools, selections, and the timeline's frame-window highlight are all the same blue.

---

← Testing  |  Home →