Install and Run - prnvkhndlwl/Kinetrace GitHub Wiki

In one sentence: put the folder somewhere sensible, double-click the launcher, and wait once. Everything is set up inside the folder: no questions, no Python or other software needed beforehand. At the end it tells you what your computer can run. The same page is in the folder you download (docs/INSTALL.md), so it is there even when you are offline.

• What you need
• 1. Get the folder and put it somewhere sensible
• 2. Start it the first time
• 3. You are done: starting it again
• Which models run on which computer
• Optional models that need Meta's permission
• Where Kinetrace keeps things
• Uninstalling
• Updating
• When something goes wrong
• How it works underneath
• Words used on this page
• Choices for experts

Download it from the project page with Code → Download ZIP and unzip it: the folder is called Kinetrace-main (rename it to Kinetrace if you like). Or clone it with git, git clone https://github.com/prnvkhndlwl/Kinetrace.git, which makes a folder called Kinetrace; Help → Check for Updates… then updates it with git pull. The name and the place do not matter, and the folder can be moved or renamed later (the launcher repairs itself).

Where to put it. Somewhere in your own user folder that is not synced to the cloud, for example:

• Mac: your home folder, i.e. Kinetrace next to Documents (in Finder: Go → Home). Not in Documents, Desktop or Downloads: macOS lets an app read those only with your permission, and Kinetrace.app started from Finder can then fail to open (the setup warns if the folder is there). With iCloud Drive → Desktop & Documents Folders on, iCloud would also upload the 1.5 GB environment and the models, and Optimize Mac Storage can remove files from the disk, which breaks the program. Already there? Move the whole folder to your home folder: it repairs itself. An external drive formatted for Windows (exFAT) may not work.
• Windows: e.g. C:\Kinetrace or a folder in your user folder. Avoid folders that OneDrive or Dropbox sync.
• Ubuntu: anywhere in your home folder, e.g. ~/Kinetrace.

Double-click run.bat. If Windows shows "Windows protected your PC", click More info → Run anyway. It is a plain script; you can open it in Notepad to read it.

1. Double-click Kinetrace.command.
2. The Mac refuses the first time, because the file came from the internet and is not signed by Apple: "Kinetrace.command" cannot be opened (or "Apple could not verify…"). Click Done (or OK), not Move to Trash.

   • macOS 15 and newer: open System Settings → Privacy & Security, scroll down to the line about Kinetrace.command, click Open Anyway and confirm with your password or Touch ID. Kinetrace then starts (on some macOS versions you double-click Kinetrace.command once more and click Open).

   • macOS 14: right-click (or Control-click) Kinetrace.command, choose Open, and confirm.

   • Or, in Terminal, once (adjust the path to where you put the folder):

     xattr -dr com.apple.quarantine ~/Kinetrace

3. A Terminal window opens and the setup runs in it. Keep it open until it says Kinetrace … is installed and ready (a few minutes the first time).
4. At the end the setup makes Kinetrace.app in the folder and opens Kinetrace with it. The Terminal window is then no longer needed: close it (closing it does not close Kinetrace). Its last lines say what must stay in the folder and what may be deleted, and Kinetrace's first window says it once more.

Open a terminal in the folder and type ./run.sh (or double-click run.sh and choose Run in Terminal). If the window's system libraries are missing, the launcher installs them with apt. That is the one step that asks for your password; when it cannot ask, it prints the exact sudo apt-get install … line.

1. Looks for a usable Python 3.10 – 3.14. On a Mac it always fetches its own private copy instead, so that updating Homebrew can never break Kinetrace. If there is none, it downloads a private copy (15 – 30 MB, checksum-checked) into .venv/base inside the folder. Nothing is installed into the operating system.
2. Creates the private environment .venv and installs the packages into it (most of the size above is PyTorch). The right PyTorch build is chosen for you: CUDA with an NVIDIA GPU, CPU without one, Metal on a Mac.
3. Fetches the code of AllTracker, the default point model, at a fixed version (its 66 MB weights download on the first Track).
4. Checks that everything works and prints the system check: what was found (graphics card, memory, PyTorch build) and, feature by feature, what runs on this computer, what runs slower, and what is switched off.

The steps are numbered (==== Step 2 of 4 …); the many lines in between are the package installer's own messages. Everything is also written to logs/install-<date>.log in the folder (the newest three are kept). If the download is interrupted, start the launcher again: what is already installed is kept and it goes on from there.

• Windows: double-click the Kinetrace shortcut in the folder (the first run made it, with the Kinetrace icon). It starts in seconds with no black window. Right-click it → Pin to Start or Pin to taskbar to keep it there, or use Help → Add Kinetrace to the Start Menu (an entry outside the folder: remove it with the same menu before deleting the folder). If an update or a moved folder needs a setup step, the shortcut opens run.bat's window; after moving the folder, double-click run.bat once to renew the shortcut. run.bat still works too: keep its black window open while you use Kinetrace (closing it closes Kinetrace).
• Mac: double-click Kinetrace.app in the folder. It starts in seconds with no Terminal window (its messages go to logs/launcher.log). Drag it to the Dock to keep it there. It is made on your Mac during the first run, so macOS does not ask about it. It shows as Kinetrace in the Dock, the menu bar and ⌘-Tab. (Kinetrace.command still works: it opens a Terminal, checks the setup and hands over to Kinetrace.app, after which the Terminal can be closed.) If a later update or a moved folder needs a setup step, Kinetrace.app opens the Terminal window for that step by itself, and the same goes: close it once Kinetrace's window is open. If Kinetrace.app says it cannot open or write in its folder, the folder is in Documents, Desktop or Downloads: move it to your home folder.
• Ubuntu: ./run.sh.

The first Track downloads the point model (66 MB) and the first outline the silhouette model (617 MB), each with a progress window. After that Kinetrace works offline.

Keys on a Mac: where this documentation says Ctrl, press ⌘ (Cmd); Alt is ⌥ (Option). Kinetrace's own key reference and its manual (F1) already show them that way on a Mac. Settings is ⌘,, or Kinetrace → Settings… in the menu bar, as on every Mac app (Edit → Settings… on Windows and Ubuntu).

Ball markers on a Mac (wand calibration, the SAM circle per ball) run on the Apple GPU: 2.1 frames/s at 1280×720 on an M4 Max, 3.3× faster than its CPU.

Neither is needed to track animals: without them Kinetrace uses SAM 2.1 for outlines and ViTPose for human joints. Meta releases them only on request, so they cannot be fetched automatically. The install makes the folders they go in, each with a PUT_FILES_HERE.txt naming the exact files (on a Mac only models/sam3, since SAM 3D Body cannot run there).

The easy way, without Terminal:

1. Make a free account at huggingface.co, open huggingface.co/facebook/sam3, click Agree and access repository, and wait until that page says you have access.
2. Make a Read token: huggingface.co/settings/tokens → Create new token → type Read → copy it.
3. In Kinetrace: Ctrl+, (⌘, on a Mac) opens Settings → Hugging Face token: paste it, Save token → Segmentation model: SAM 3.
4. The first outline downloads SAM 3 (3.4 GB) with a progress window. From then on it works offline, and it becomes the default.

Or, from a Terminal opened in the Kinetrace folder (Mac / Ubuntu):

export HF_HOME="$PWD/models/hf" HF_HUB_DISABLE_UPDATE_CHECK=1
.venv/bin/python -m huggingface_hub.cli.hf auth login
.venv/bin/python -m huggingface_hub.cli.hf download facebook/sam3 --revision 3c879f39826c281e95690f02c7821c4de09afae7 --exclude "sam3.pt" --local-dir models/sam3

On Windows, in a Command Prompt in the Kinetrace folder:

set HF_HOME=%CD%\models\hf
set HF_HUB_DISABLE_UPDATE_CHECK=1
.venv\Scripts\python.exe -m huggingface_hub.cli.hf auth login
.venv\Scripts\python.exe -m huggingface_hub.cli.hf download facebook/sam3 --revision 3c879f39826c281e95690f02c7821c4de09afae7 --exclude "sam3.pt" --local-dir models\sam3

The first lines keep Hugging Face's own files inside the Kinetrace folder and stop its check for a newer version. auth login asks for the Read token without showing it and keeps it in models/hf/token, the same file Kinetrace's Settings uses, so the token never ends up in the Terminal's history. (It may offer to save it as a git credential: answer no.)

The --exclude "sam3.pt" leaves out a second 3.45 GB copy of the weights that Kinetrace does not use (a plain download is 6.9 GB). The --revision is the version Kinetrace was tested with.

Mac users: skip this. It cannot run on a Mac or on a computer without an NVIDIA graphics card; the Body dialog offers ViTPose (2D joints) there.

1. Request access at huggingface.co/facebook/sam-3d-body-dinov3.

2. Download its two files into models/sam-3d-body-dinov3, from a Terminal in the Kinetrace folder (on Windows: the set lines and .venv\Scripts\python.exe as for SAM 3 above):

   export HF_HOME="$PWD/models/hf" HF_HUB_DISABLE_UPDATE_CHECK=1
   .venv/bin/python -m huggingface_hub.cli.hf auth login
   .venv/bin/python -m huggingface_hub.cli.hf download facebook/sam-3d-body-dinov3 model.ckpt assets/mhr_model.pt --local-dir models/sam-3d-body-dinov3

   model.ckpt is 2.1 GB; assets/mhr_model.pt (0.7 GB) sits in a sub-folder and is easy to miss.

3. Clone Meta's code into a new folder models/sam-3d-body:

   git clone https://github.com/facebookresearch/sam-3d-body models/sam-3d-body

Its Python packages are already installed. Body → Find People & Measure Joints… says, beside the SAM 3D Body model, what is still missing.

Inside the Kinetrace folder (deleting the folder removes all of these): the environment (.venv), the models (models/), the error and install logs (logs/), unsaved-work recovery copies (recovery/), saved skeletons (skeletons/), the tour's demo video (demo/, made by Help → Take the Interface Tour), your settings (settings.ini), on a Mac Kinetrace.app and on Windows the Kinetrace shortcut (its icon is .venv\kinetrace.ico).

Outside it:

• Your projects, exports and calibration files: wherever you save them. They are never deleted by an update or by uninstalling.
• Only if the Kinetrace folder cannot be written (installed read-only): the logs and recovery copies go to %LOCALAPPDATA%\Kinetrace (Windows), ~/Library/Application Support/Kinetrace (Mac) or ~/.local/share/kinetrace (Ubuntu).
• Kinetrace 0.4.1 and earlier kept your name for notes in the registry (HKEY_CURRENT_USER\Software\Kinetrace), ~/Library/Preferences/com.kinetrace.Kinetrace.plist (Mac) or ~/.config/Kinetrace (Ubuntu). Newer versions use settings.ini in the folder instead.
• PyTorch may make an empty torchinductor_<you> folder in the system's temporary folder; the system clears it.
• Hugging Face's own hf command, when run WITHOUT the HF_HOME line shown above, keeps its token and a few small files in ~/.cache/huggingface.
• Qt, the toolkit Kinetrace's windows are made with, remembers the last folder you browsed in its file dialogs: ~/Library/Preferences/com.qtproject.plist (Mac), ~/.config/QtProject.conf (Ubuntu) or the registry key HKEY_CURRENT_USER\Software\QtProject (Windows). Every program built with Qt shares it, so uninstalling Kinetrace leaves it alone.
• Windows, only if you used Help → Add Kinetrace to the Start Menu: the Start menu entry %APPDATA%\Microsoft\Windows\Start Menu\Programs\Kinetrace.lnk. A copy you pinned to Start or the taskbar is Windows' own, kept until you unpin it.
• macOS remembers that you allowed Kinetrace.command and Terminal's access to the folder (System Settings → Privacy & Security).

To see every one of these on your computer, with sizes: Help → Kinetrace's Folders… (each one opens with Show in Finder / the file manager), or ./run.sh --paths / run.bat --paths.

Mac / Ubuntu: in a Terminal, bash uninstall.sh in the Kinetrace folder. It shows the folder and asks you to type DELETE. Then, if Kinetrace left anything in the shared folders outside it (see above), it lists them and removes them only if you answer yes: another Kinetrace copy on the same computer may still use them. It stops without deleting anything if a project is saved inside the Kinetrace folder, and names it so you can move it first. To do it by hand on a Mac:

rm -rf ~/Kinetrace "$HOME/Library/Application Support/Kinetrace" ~/Library/Preferences/com.kinetrace.Kinetrace.plist

(with your folder's path in place of ~/Kinetrace). Also remove Kinetrace from the Dock if you put it there.

Windows: close Kinetrace (if you added it to the Start menu, first use Help → Remove Kinetrace from the Start Menu, and unpin it from Start or the taskbar), then delete the Kinetrace folder, and %LOCALAPPDATA%\Kinetrace if it exists. To remove the old settings of 0.4.1 and earlier, in a Command Prompt:

reg delete HKCU\Software\Kinetrace /f

Your projects and exports are not touched by any of this.

Help → Check for Updates… asks GitHub for the newest version (one request; nothing about you is sent, and nothing is checked unless you ask), shows what is new, and Update now installs it. When you have not checked for 30 days, a note at start says so (click it to check; it comes back at most once a week until you do); that reminder only counts days, it never goes online. A folder made with git clone is updated with git: on a Mac whose Command Line Tools are missing or broken (often after a macOS upgrade), Update now stays off and the window says how to repair them (xcode-select --install in Terminal), or run git pull in the folder yourself. Only changed files are replaced; .venv/, models/, recovery/, logs/, skeletons/, demo/, settings.ini and your footage are never touched. When the app will not start, double-click update.bat (Windows) or Update.command (Mac), or run bash update.sh (--check only looks).

• Help → System Check… says what this computer can run and why; run.bat --check / ./run.sh --check prints the same without a window.
• Help → Error Report… shows what went wrong, with Copy and Open the log folder. Nothing is ever sent anywhere by Kinetrace.
• To ask for help: open an issue at github.com/prnvkhndlwl/Kinetrace/issues. Attach the Error Report, or for an install problem the newest logs/install-*.log. Read it first: it contains folder names from your computer.

Without a GPU everything works; the models are several times slower (a 4K video takes hours rather than minutes) and SAM 3D Body is switched off, because Meta's code runs only on an NVIDIA card — the Body dialog greys it out and says so; the 2D model (ViTPose) is offered instead. For silhouettes, SAM 2.1 base+ is the practical choice on a CPU. AllTracker works on a smaller picture on computers with little memory (the system check says which size). The GPU is used whenever it is faster. The first start times a small workload shaped like the models' inner loops on the GPU and on the CPU (a few seconds, remembered in models/device_benchmark.json), and the faster one does the work — on a normal machine the GPU wins by a wide margin, and a GPU that cannot run the workload (a broken driver) is simply not used (and tried again at the next start — there is no file to delete). The status bar shows a coloured badge: green ● GPU with the card's name, or amber ● CPU (with "(… available)" when a GPU exists but lost the comparison). Hover over it for the measured times and what runs slower or is off here; while tracking, the speed readout also starts with GPU or CPU. Help → System Check… has the full report (with a Copy button for support requests). The same report prints from a terminal with run.bat --check / ./run.sh --check, which also installs first if needed and never opens a window.

When something goes wrong, Kinetrace writes it down: every error (with where in the program it happened and what you were doing), Qt's own warnings, and — when the program dies of a native crash — the stack of every thread, go to kinetrace.log and kinetrace-crash.log in the logs/ folder inside the Kinetrace folder (the per-user data folder when the Kinetrace folder is read-only). A red notice says so on screen (at most once every ten seconds). Help → Error Report… shows the recent errors plus the System Check, with Copy for a bug report and Open the log folder to attach the files (two Kinetrace windows open at once share the log safely); a session marked "did NOT end normally" is one that closed by itself. Nothing is ever sent anywhere.

Models are downloaded the first time a feature needs them, into models/ inside the folder: the AllTracker point model (66 MB on the first Track), CoTracker3 (~100 MB + its code, only if you switch to it), SAM 2.1 for silhouettes (~620 MB), ViTPose + RT-DETR for human poses (~500 MB). A window shows what is downloading, how far it has got and about how long is left, with Cancel (the next try carries on); a connection cut half way resumes where it stopped, a stalled connection gives up after 30 s with a sentence instead of hanging, and a full disk is reported as a full disk. Every download is pinned and checked: each file is the one of a fixed upstream version (a commit), its checksum is compared before use, and a file that differs is deleted, never run; model weights are read as plain numbers (weights_only), never as code. Once a model is in models/, loading it asks nothing of the internet. An internet connection is needed only for these first downloads.

A new version is published by changing APP_VERSION in kinetrace/__init__.py and pushing it to main: the Release workflow (.github/workflows/release.yml) tags that commit vX.Y.Z and publishes a GitHub Release with notes written from the commits. Pushes that leave the version alone are not offered to anyone.

• Terminal (Mac, Ubuntu) / Command Prompt (Windows): the window where you type commands. On a Mac: Finder → Applications → Utilities → Terminal. "A Terminal in the Kinetrace folder" means: open Terminal, type cd (with a space), drag the Kinetrace folder onto the window, press Enter.
• Python: the programming language Kinetrace is written in. Kinetrace brings its own copy if needed.
• Environment, .venv: the folder inside Kinetrace that holds its private Python and the packages it needs (PyTorch, Qt, OpenCV…). Kept apart from anything else on the computer. Deleting .venv and starting the launcher again rebuilds it from scratch.
• PyTorch: the engine that runs the tracking and outline models.
• Model / weights: the trained network a feature uses, a file of numbers downloaded once into models/.
• Hugging Face: the website most models are downloaded from.
• Gated: a model whose authors (here Meta) must approve each person before they can download it.
• Token / Read token: a password-like code from your Hugging Face account that lets Kinetrace download a gated model for you. "Read" means it can only download, nothing else. Keep it to yourself.
• Gatekeeper: the part of macOS that blocks programs downloaded from the internet until you allow them once.

Environment variables, set before the first run or before starting:

To install by hand: make a virtual environment with Python 3.10 – 3.14, then run python install.py inside it (--force reinstalls the packages).

← Home  |  Workflow: track an animal →