funtracks 1.3.0

Cell tracking data model

Funtracks

A data model for cell tracking with actions, undo history, persistence, and more!

The full documentation can be found here.

---

Installation

pip install funtracks (soon)

Alternatively, you can use pixi to install and run funtracks code. For example, to run the tests, you can call pixi run test to run our pre-configured pixi task in the testing environment.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Updating documentation

We are using mkdocs-material and mike to get versioned documentation. Mike will push changes to the gh-pages branch, which we can serve from the Github Pages settings. This should happen automatically from the github action upon push to 'main' (with alias 'dev') and newly tagged version (with alias 'latest'), but we are documenting it here in case we need to do it manually at some point.

To publish a commit to the gh-pages branch manually:

pixi run -e docs mike deploy <version> <alias>

To preview pushed chnages locally:

pixi run -e docs mike serve

Remember not to push your local gh-pages branch on accident after previewing changes. To reset your local branch to the remote gh-pages, you can run:

git fetch
git checkout gh-pages
git reset --hard origin/gh-pages