movement

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

https://github.com/neuroinformatics-unit/movement

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    2 of 5 committers (40.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.6%) to scientific vocabulary

Keywords

animal behavior behaviour ethology kinematics motion-tracking neuroscience
Last synced: 6 months ago · JSON representation ·

Repository

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

Basic Info
Statistics
  • Stars: 193
  • Watchers: 8
  • Forks: 71
  • Open Issues: 141
  • Releases: 33
Topics
animal behavior behaviour ethology kinematics motion-tracking neuroscience
Created almost 6 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation

README.md

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): bash 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.

Owner

  • Name: SWC/GCNU Neuroinformatics Unit
  • Login: neuroinformatics-unit
  • Kind: organization
  • Location: United Kingdom

Citation (CITATION.CFF)

cff-version: 1.2.0
title: movement
message: >-
  If you use movement in your work, please cite the following Zenodo DOI.
type: software
authors:
  - given-names: Nikoloz
    family-names: Sirmpilatze
    orcid: 'https://orcid.org/0000-0003-1778-2427'
    email: niko.sirbiladze@gmail.com
  - given-names: Chang Huan
    family-names: Lo
  - given-names: Sofía
    family-names: Miñano
  - given-names: Brandon D.
    family-names: Peri
  - given-names: Dhruv
    family-names: Sharma
  - given-names: Laura
    family-names: Porta
  - given-names: Iván
    family-names: Varela
  - given-names: Adam L.
    family-names: Tyson
    email: code@adamltyson.com
identifiers:
  - type: doi
    value: 10.5281/zenodo.12755724
    description: 'A collection of archived snapshots of movement on Zenodo.'
repository-code: 'https://github.com/neuroinformatics-unit/movement'
url: 'https://movement.neuroinformatics.dev/'
abstract: >-
  Python tools for analysing body movements across space and time.
keywords:
  - behavior
  - behaviour
  - kinematics
  - neuroscience
  - animal
  - motion
  - tracking
  - pose
license: BSD-3-Clause

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 40
  • Total Committers: 5
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.65
Past Year
  • Commits: 27
  • Committers: 4
  • Avg Commits per committer: 6.75
  • Development Distribution Score (DDS): 0.481
Top Committers
Name Email Commits
Niko Sirmpilatze n****e@g****m 14
Adam Tyson a****n@u****k 13
pre-commit-ci[bot] 6****] 8
Chang Huan Lo c****o@u****k 4
Dhruv 4****y 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 271
  • Total pull requests: 586
  • Average time to close issues: 3 months
  • Average time to close pull requests: 17 days
  • Total issue authors: 21
  • Total pull request authors: 51
  • Average comments per issue: 1.69
  • Average comments per pull request: 3.21
  • Merged pull requests: 371
  • Bot issues: 0
  • Bot pull requests: 57
Past Year
  • Issues: 127
  • Pull requests: 375
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 15 days
  • Issue authors: 18
  • Pull request authors: 48
  • Average comments per issue: 1.79
  • Average comments per pull request: 3.26
  • Merged pull requests: 197
  • Bot issues: 0
  • Bot pull requests: 33
Top Authors
Issue Authors
  • niksirbi (121)
  • sfmig (69)
  • lochhh (37)
  • willGraham01 (12)
  • adamltyson (8)
  • vigji (5)
  • decembboy (3)
  • hummuscience (3)
  • luiztauffer (2)
  • b-peri (2)
  • Udayscode (1)
  • jmdelahanty (1)
  • UTSAVS26 (1)
  • stellaprins (1)
  • rly (1)
Pull Request Authors
  • niksirbi (167)
  • sfmig (110)
  • lochhh (72)
  • pre-commit-ci[bot] (41)
  • willGraham01 (31)
  • github-actions[bot] (13)
  • stellaprins (11)
  • demoncoder-crypto (11)
  • Ishaan0132 (10)
  • harsh-bhanushali-05 (10)
  • Mahi7828 (10)
  • b-peri (9)
  • DhruvSkyy (8)
  • pererakavindu (8)
  • anmolecule94 (7)
Top Labels
Issue Labels
enhancement (180) bug (33) documentation (26) GUI (14) question (11) core feature (7) good first issue (7) dependencies (2)
Pull Request Labels
GUI (9) dependencies (7) enhancement (4) github_actions (3) documentation (2) core feature (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 740 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 4
  • Total versions: 37
  • Total maintainers: 2
pypi.org: movement

Analysis of body movement

  • Versions: 37
  • Dependent Packages: 0
  • Dependent Repositories: 4
  • Downloads: 740 Last month
Rankings
Dependent repos count: 7.5%
Dependent packages count: 10.0%
Average: 13.2%
Downloads: 14.0%
Stargazers count: 15.6%
Forks count: 19.1%
Maintainers (2)
Last synced: 6 months ago

Dependencies

.github/workflows/docs_build_and_deploy.yml actions
  • neuroinformatics-unit/actions/build_sphinx_docs v2 composite
  • neuroinformatics-unit/actions/deploy_sphinx_docs v2 composite
.github/workflows/test_and_deploy.yml actions
  • actions/cache v3 composite
  • actions/download-artifact v3 composite
  • neuroinformatics-unit/actions/build_sdist_wheels v2 composite
  • neuroinformatics-unit/actions/check_manifest v2 composite
  • neuroinformatics-unit/actions/lint v2 composite
  • neuroinformatics-unit/actions/test v2 composite
  • pypa/gh-action-pypi-publish v1.5.0 composite
docs/requirements.txt pypi
  • linkify-it-py *
  • matplotlib *
  • myst-parser *
  • nbsphinx *
  • pydata-sphinx-theme *
  • setuptools-scm *
  • sphinx <7.2
  • sphinx-autodoc-typehints *
  • sphinx-design *
  • sphinx-gallery *
pyproject.toml pypi
  • attrs *
  • h5py *
  • numpy *
  • pandas *
  • pooch *
  • sleap-io *
  • tqdm *
  • xarray *