Package: eargait
EarGait - The Gait Analysis Package for Ear-Worn IMU Sensors !EarGaitprovides a set of algorithms and functions to process IMU data recorded with ear-worn IMU sensors and to
estimate characteristic gait parameters.Getting startedInstallationEasily installeargaitvia pip:pip install eargaitor add it to your project withpoetry:poetry add eargaitNewest version1.2.0should be installed.PrerequisitesEarGaitonly supports Python 3.8 and newer.
First, install a compatible version of Python.Help with setting up a virtual environmentWe recommend installing the packages in a virtual environment (e.g. conda/Anaconda/miniconda).
For more information regarding Anaconda, please visitAnaconda.com.If you want to install the packages directly on the local python version, directly go toInstall PackagesIf you are familiar with virtual environments you can ``also use any other type of virtual environment.
Furthermore, you can also directly install the python packages on the local python version, however, we would not recommend doing so.In PyCharmSeedocumentation.Shell/TerminalFirst, verify that you have a working conda installation. Open a terminal/shell and typeconda env listIf an error message similar to the one below is displayed, you probably do not have a working conda version installed.conda: command not foundIn the shell/terminal:conda create --no-default-packages -n gait_analysis python=3.8gait_analysisis the name of the virtual environment. This environment can now also be included in PyCharm,
as described Seehereby using the existing environment option.To check, whether the virtual environment has been created successfully, run again:conda env listThe environmentgait_analysisshould now be displayed.Activate conda environment and install packages (see below).conda activate gait_analysisFor more help:Conda DocumentationInstall Package in virtual environmentIf you are using the conda environment, activate environment (in shell/terminal) (see above).
Update pip and installeargait.pip install --upgrade pip 
pip install eargaitCheck successful installationTo check whether the installation was successful, run the following line directly after installingeargaitin the same shell/terminal:python examples/check_installation/check_installation.pyShould return:Installation was successful!Learn MoreDocumentation,User Guide,Coordinate SystemsDev SetupWe are using poetry to manage dependencies and poethepoet to run and manage dev tasks.To set up the dev environment including the required dependencies for using EarGait run the following commands:git clone https://github.com/mad-lab-fau/eargait
cd eargait
poetry installAfterwards you can start to develop and change things.
If you want to run tests, format your code, build the docs, ...,
you can run one of the following poethepoet commandsCONFIGURED TASKS
  format         
  lint           Lint all files with Prospector.
  check          Check all potential format and linting issues.
  test           Run Pytest with coverage.
  docs           Build the html docs using Sphinx.
  bump_versionby callingpoetry run poe <command name>Citing EarGaitIf you useEargaitin your work, please report the version you used in the text. Additionally, please also cite the corresponding paper:[1] Seifer et al., "EarGait: estimation of temporal gait parameters from hearing aid 
integrated inertial sensors." Sensors 23(14), 2023. https://doi.org/10.3390/s23146565.

[2] PREPRINT Seifer et al., (2023). Step length and gait speed estimation using a hearing aid 
integrated accelerometer: A comparison of different algorithms.Links:[1] Seifer et al., (2023), Temporal Parameter Paper[2] Seifer et al., (2023); Spatial Parameter Paper--> PREPRINTAcknowledgementEarGait is part of a research project from the Machine Learning and Data Analytics Lab, Friedrich-Alexander Universität Erlangen-Nürnberg. The authors thank WS Audiology, Erlangen, Germany and Lynge, Denmark for funding the work and their support which made this contribution possible.ContributionThe entire development is managed viaGitHub.
If you run into any issues, want to discuss certain decisions, want to contribute features or feature requests, just
reach out to us byopening a new issue.