fix ci_test snapshot, readthedocs

.github/workflows/test-and-lint.yml

@@ -31,7 +31,7 @@ jobs:
         poetry run poe check
     - name: Testing
       run: |
-        poetry run poe test
+        poetry run poe test_ci
     - name: "Upload coverage to Codecov"
       uses: codecov/codecov-action@v2
       with:

.readthedocs.yml

@@ -14,7 +14,7 @@ build:
   tools:
     python: "3.9"
   jobs:
-    post_install:
+    post_create_environment:
       - pip install poetry
-      - poetry config virtualenvs.create false
-      - poetry install
+    post_install:
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --all-extras

docs/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) (+ the Migration Guide),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) (+ the Migration Guide and 
+Scientific Changes section), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+For more information see the 
+[Github Releases Page](https://github.com/mad-lab-fau/gaitmap/releases) of this 
+project.
+
+## [2.8.0] - 2024-05-07
+
+- Testing using Snapshots
+- Recent Models for Random Forest Spatial Parameter using Static Gravity Alignment based on accelerometer.
 

docs/README.md

@@ -0,0 +1,155 @@
+[![PyPI](https://img.shields.io/pypi/v/eargait)](https://pypi.org/project/eargait/)
+[![Documentation Status](https://readthedocs.org/projects/eargait/badge/?version=latest)](https://eargait.readthedocs.io/en/latest/?badge=latest)
+[![Test and Lint](https://github.com/mad-lab-fau/eargait/actions/workflows/test-and-lint.yml/badge.svg?branch=main)](https://github.com/mad-lab-fau/eargait/actions/workflows/test-and-lint.yml)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/eargait)
+
+# EarGait - The Gait Analysis Package for Ear-Worn IMU Sensors !
+
+*EarGait* provides a set of algorithms and functions to process IMU data recorded with ear-worn IMU sensors and to 
+estimate characteristic gait parameters. 
+
+
+<p align="center">
+  <img src="./docs/_static/logo/WalkingHearingAid.png" height="200"/>
+</p>
+
+## Getting started
+
+### Installation
+
+Easily install `eargait` via pip:
+```
+pip install eargait
+```
+
+or add it to your project with [poetry](https://python-poetry.org/):
+```
+poetry add eargait
+```
+
+Newest version `1.2.0` should be installed.
+
+### Prerequisites
+*EarGait* only supports Python 3.8 and newer.
+First, install a compatible version of Python.
+
+### Help with setting up a virtual environment
+We recommend installing the packages in a virtual environment (e.g. conda/Anaconda/miniconda).
+For more information regarding Anaconda, please visit [Anaconda.com](https://docs.anaconda.com/anaconda/install/index.html). <br />
+If you want to install the packages directly on the local python version, directly go to [Install Packages](#install-packages)  <br />
+
+If 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 PyCharm** <br />
+See [documentation](https://www.jetbrains.com/help/pycharm/conda-support-creating-conda-virtual-environment.html).
+
+**Shell/Terminal** <br /> 
+First, verify that you have a working conda installation. Open a terminal/shell and type
+```
+conda env list
+```
+If an error message similar to the one below is displayed, you probably do not have a working conda version installed. 
+```
+conda: command not found
+```
+In the shell/terminal:
+```
+conda create --no-default-packages -n gait_analysis python=3.8
+```
+*gait_analysis* is the name of the virtual environment. This environment can now also be included in PyCharm, 
+as described See [here](https://www.jetbrains.com/help/pycharm/conda-support-creating-conda-virtual-environment.html) 
+by using the existing environment option. <br /> 
+To check, whether the virtual environment has been created successfully, run again:
+```
+conda env list
+```
+The environment *gait_analysis* should now be displayed.  <br /> 
+Activate conda environment and install packages (see below).
+
+```
+conda activate gait_analysis
+```
+
+For more help: [Conda Documentation](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
+
+
+### Install Package in virtual environment
+If you are using the conda environment, activate environment (in shell/terminal) (see above).
+Update pip and install `eargait`.
+```
+pip install --upgrade pip 
+pip install eargait
+```
+
+## Check successful installation
+
+To check whether the installation was successful, run the following line directly after installing `eargait` in the same shell/terminal: 
+```
+python examples/check_installation/check_installation.py
+```
+Should return: `Installation was successful!`
+
+
+## Learn More
+[Documentation](https://eargait.readthedocs.io/en/latest/),
+[User Guide](https://eargait.readthedocs.io/en/latest/guides/index.html#user-guides),
+[Coordinate Systems](https://eargait.readthedocs.io/en/latest/guides/index.html)
+
+
+## Dev Setup
+We 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 install
+```
+Afterwards 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 commands
+
+```
+CONFIGURED 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_version   
+```
+by calling
+```
+poetry run poe <command name>
+```
+
+
+## Citing EarGait
+
+If you use `Eargait` in 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: <br />
+[[1] Seifer et al., (2023), Temporal Parameter Paper](https://doi.org/10.3390/s23146565) <br />
+[[2] Seifer et al., (2023); Spatial Parameter Paper](https://www.techrxiv.org/articles/preprint/Step_length_and_gait_speed_estimation_using_a_hearing_aid_integrated_accelerometer_A_comparison_of_different_algorithms/24182496) --> PREPRINT
+
+
+## Acknowledgement
+
+EarGait 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.
+
+
+## Contribution
+
+The entire development is managed via [GitHub](https://github.com/mad-lab-fau/eargait).
+If you run into any issues, want to discuss certain decisions, want to contribute features or feature requests, just 
+reach out to us by [opening a new issue](https://github.com/mad-lab-fau/eargait/issues/new/choose).
+

pyproject.toml

@@ -84,6 +84,7 @@ _check_black = "black . --check"
 _check_isort = "isort . --check"
 check = { sequence = ["_check_black", "_check_isort", "lint"], help = "Check all potential format and linting issues.", ignore_fail = false }
 test = { cmd = "pytest --cov=eargait --cov-report=term-missing --cov-report=xml", help = "Run Pytest with coverage." }
+test_ci = { cmd = "pytest --cov=eargait --cov-report=term-missing --cov-report=xml --snapshot-only-check", help = "Run Pytest with coverage and fail on missing snapshots." }
 docs = { "script" = "_tasks:task_docs()",  help = "Build the html docs using Sphinx." }
 bump_version = { "script" = "_tasks:task_update_version()" }
 

tests/conftest.py

@@ -21,17 +21,4 @@
 @pytest.fixture(autouse=True)
 def reset_random_seed() -> None:
     np.random.seed(10)
-    random.seed(10)
-
-
-@pytest.fixture()
-def snapshot(request):
-    with PyTestSnapshotTest(request) as snapshot_test:
-        yield snapshot_test
-
-
-def pytest_addoption(parser) -> None:
-    group = parser.getgroup("snapshottest")
-    group.addoption(
-        "--snapshot-update", action="store_true", default=False, dest="snapshot_update", help="Update the snapshots."
-    )
+    random.seed(10)