Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

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

Python tools for analysing body movements across space and time
https://github.com/neuroinformatics-unit/movement

animal behavior behaviour ethology kinematics motion-tracking neuroscience

Last synced: 11 days ago
JSON representation

Python tools for analysing body movements across space and time

Lists

README 

        
[![Python Version](https://img.shields.io/pypi/pyversions/movement.svg)](https://pypi.org/project/movement)

[![License](https://img.shields.io/badge/License-BSD_3--Clause-orange.svg)](https://opensource.org/licenses/BSD-3-Clause)

![CI](https://img.shields.io/github/actions/workflow/status/neuroinformatics-unit/movement/test_and_deploy.yml?label=CI)

[![codecov](https://codecov.io/gh/neuroinformatics-unit/movement/branch/main/graph/badge.svg?token=P8CCH3TI8K)](https://codecov.io/gh/neuroinformatics-unit/movement)

[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/format.json)](https://github.com/astral-sh/ruff)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement/topic/Welcome!)



# movement



A Python toolbox for analysing body movements across space and time, to aid the study of animal behaviour in neuroscience.



![](docs/source/_static/movement_overview.png)



## Quick install



First, create and activate a conda environment with the required dependencies:

```

conda create -n movement-env -c conda-forge python=3.11 pytables

conda activate movement-env

```



Then install the `movement` package:

```

pip install movement

```



> [!Note]

> Read the [documentation](https://movement.neuroinformatics.dev) for more information, including [full installation instructions](https://movement.neuroinformatics.dev/getting_started/installation.html) and [examples](https://movement.neuroinformatics.dev/examples/index.html).



## Overview



Pose estimation tools, such as [DeepLabCut](https://www.mackenziemathislab.org/deeplabcut) and [SLEAP](https://sleap.ai/) are now commonplace when processing video data of animal behaviour. There is not yet a standardised, easy-to-use way to process the pose tracks produced from these software packages.



movement aims to provide a consistent modular interface to analyse pose tracks, allowing steps such as data cleaning, visualisation and motion quantification.

We aim to support a range of pose estimation packages, along with 2D or 3D tracking of single or multiple individuals.



Find out more on our [mission and scope](https://movement.neuroinformatics.dev/community/mission-scope.html) statement and our [roadmap](https://movement.neuroinformatics.dev/community/roadmaps.html).



## Status

> [!Warning]

> 🏗️ The package is currently in early development and the interface is subject to change. Feel free to play around and provide feedback.



## 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](https://movement.neuroinformatics.dev/community/contributing.html).



You are welcome to chat with the team on [zulip](https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement). You can also [open an issue](https://github.com/neuroinformatics-unit/movement/issues) to report a bug or request a new feature.



## License

⚖️ [BSD 3-Clause](./LICENSE)



## Package template

This package layout and configuration (including pre-commit hooks and GitHub actions) have been copied from the [python-cookiecutter](https://github.com/neuroinformatics-unit/python-cookiecutter) template.