ParticleTracker is a gui based particle tracking software that brings together a range of tools to make particle tracking simple. Full details on installation and use can be found in the documentation:
Full details in documentation but in brief:
-
Install to use
- Install uv
- cd to folder
- uv init
- uv add git+https://github.com/MikeSmithLabTeam/particletracker
- uv sync
-
Install to edit underlying code
- git clone https://github.com/MikeSmithLabTeam/particletracker
- cd particletracker
- uv sync --editable .
If you run the command below then a pre-commit hook is activated which makes sure tests are run.
- pre-commit install
The github repo is configured to run tests. ptdev branch reports the results, the main branch will reject pushes / merges which don't pass.
Add the following argument to your pyproject.toml
[project]
dependencies = [
"particletracker @ git+https://github.com/MikeSmithLabTeam/particletracker",
]
To cite this project in your publications please cite the following paper: "ParticleTracker: a gui based particle tracking software" M.I. Smith, J.G. Downs, J. Open Source Software 6, 3611 (2021)
Markdown:
Details about contributing to the ParticleTracker project can be found here
This project is licensed under the terms of the MIT licence (https://github.com/MikeSmithLabTeam/particletracker/blob/master/license.txt).