Skip to main content

A Python toolbox for analysing animal body movements across space and time

Project description

Python Version PyPI Version Conda Forge Version Downloads License CI codecov Binder Code style: Ruff pre-commit project chat DOI

movement

A Python toolbox for analysing animal body movements across space and time.

Quick install

Create and activate a conda environment with movement installed (including the GUI):

conda create -n movement-env -c conda-forge movement napari pyqt6
conda activate movement-env

[!Note] Read the documentation for more information, including full installation instructions and examples.

Overview

Deep learning methods for motion tracking have revolutionised a range of scientific disciplines, from neuroscience and biomechanics, to conservation and ethology. Tools such as DeepLabCut and SLEAP now allow researchers to track animal movements in videos with remarkable accuracy, without requiring physical markers. However, there is still a need for standardised, easy-to-use methods to process the tracks generated by these tools.

movement aims to provide a consistent, modular interface for analysing motion tracks, enabling steps such as data cleaning, visualisation, and motion quantification. We aim to support all popular animal tracking frameworks and file formats.

Find out more on our mission and scope statement and our roadmap.

[!Tip] If you prefer analysing your data in R, we recommend checking out the animovement toolbox, which is similar in scope. We are working together with its developer to gradually converge on common data standards and workflows.

Join the movement

movement is made possible by the generous contributions of many people.

We welcome and encourage contributions in any form—whether it is fixing a bug, developing a new feature, or improving the documentation—as long as you follow our code of conduct.

Go to our community page to find out how to connect with us and get involved.

Citation

If you use movement in your work, please cite the following Zenodo DOI:

Nikoloz Sirmpilatze, Chang Huan Lo, Sofía Miñano, Brandon D. Peri, Dhruv Sharma, Laura Porta, Iván Varela & Adam L. Tyson (2024). neuroinformatics-unit/movement. Zenodo. https://zenodo.org/doi/10.5281/zenodo.12755724

License

⚖️ BSD 3-Clause

Package template

This package layout and configuration (including pre-commit hooks and GitHub actions) have been copied from the python-cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

movement-0.17.0.tar.gz (127.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

movement-0.17.0-py3-none-any.whl (132.9 kB view details)

Uploaded Python 3

File details

Details for the file movement-0.17.0.tar.gz.

File metadata

  • Download URL: movement-0.17.0.tar.gz
  • Upload date:
  • Size: 127.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for movement-0.17.0.tar.gz
Algorithm Hash digest
SHA256 d1c70237b065fadfa45edba740b1707924a9fcef9611bf1845050bb3fac0b58e
MD5 cb3898e4e3bba89a49739508501dd59b
BLAKE2b-256 c75fd4730e2dd65ebf5d937f0651a8dccb268362994796d9ccd6582eaf62d471

See more details on using hashes here.

File details

Details for the file movement-0.17.0-py3-none-any.whl.

File metadata

  • Download URL: movement-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 132.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for movement-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41041b377f0b1daac619fad5a5273a349cfbb743cc97fc88072b6c70793b3b6d
MD5 01e3121218696ba685de3f1fa859749b
BLAKE2b-256 e5b6aca4586f8602ab0d20275a586d70faf0a17942a444e6bb46307fa36c7cc6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page