Skip to content

mad-lab-fau/gaitmap

Repository files navigation

gaitmap - The Gait and Movement Analysis Package

gaitmap provides a set of algorithms to analyze your IMU movement data without getting into your way. Its API is designed to mimic sklearn to provide you a familiar and elegant interface.

pipeline status coverage report docs Code style: black

Getting started

Installation

gaitmap only supports Python 3.8 and newer. First, install a compatible version of Python.

Then you need to install the provided packages. Gaitmap is split into two packages: gaitmap and gaitmap_mad. To get access to all available algorithms, you need to install both packages.

For now, simply installing gaitmap will install both packages, but this will change in the future!

For a stable experience install one of our releases (e.g. 2.0).

All new releases (>=2.0) can be found on Github. All old releases are available via MaD-Lab internal Gitlab.

# gaitmap
pip install git+https://github.com/mad-lab-fau/[email protected] --upgrade

The latest git (bleeding edge) version:

# gaitmap
pip install git+https://github.com/mad-lab-fau/gaitmap.git --upgrade

If you are planning to make any changes to the library, please refer to the developer section below.

Working with Algorithms

gaitmap is designed to be a toolbox and not a single algorithm. This means you are expected to pick and use individual algorithms. A good way to get an overview over the available algorithms and possibilities is to look at the Examples. It is also highly advisable to read through the guides on Coordinate Systems and the Common Datatypes.

For Developers

The Development Guide and the Project Structure Guide have detailed information for all new developers. Below, we included some very basic information as a quick reference here in the README.

Install Python >3.7 and poetry. Then run the commands below to get the latest source and install the dependencies:

git clone https://mad-srv.informatik.uni-erlangen.de/MadLab/GaitAnalysis/gaitmap.git
poetry install

Note, that you don't need to care about the gaitmap_mad subpackage. All dependencies are specified in the main pyproject.toml and the gaitmap_mad will be installed in editable mode when running poetry install.

To run any of the tools required for the development workflow, use the doit commands:

$ poetry run doit list
docs                 Build the html docs using Sphinx.
format               Reformat all files using black.
format_check         Check, but not change, formatting using black.
lint                 Lint all files with Prospector.
register_ipykernel   Add a jupyter kernel with the gaitmap env to your local install.
test                 Run Pytest with coverage.
type_check           Type check with mypy.
update_version       Bump the version in pyproject.toml and gaitmap.__init__ .