Skip to main content

Analysis of body movement

Project description

Python Version PyPI Version Conda Forge Version 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 pyqt
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

Contributions to movement are absolutely encouraged, whether to fix a bug, develop a new feature, or improve the documentation. To help you get started, we have prepared a detailed contributing guide.

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.6.1.tar.gz (85.5 kB view details)

Uploaded Source

Built Distribution

movement-0.6.1-py3-none-any.whl (85.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for movement-0.6.1.tar.gz
Algorithm Hash digest
SHA256 5af89dad5ca95af5cdee68879a59dd04f866ad6e717f97d0fd00d43cc755cf39
MD5 60348701d66cf7cc24326cce3b8f3401
BLAKE2b-256 cf4eafa594b66e7705d87066017ffac87d0b5c9d0c5f558d31cffce227175c7e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for movement-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d6ad462d444179197d989dacf71a8c47ae482dd3c1948130997f5947f6d7e6a2
MD5 cf9b940387c9f1076d0c371345fd1da0
BLAKE2b-256 f5538bc98cfea2b8fb8a2f2efa02c0a2a6a0118181ea60aee25ad5d9127975a4

See more details on using hashes here.

Supported by

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