New Release

CHANGELOG.md

@@ -8,7 +8,7 @@ For more information see the
 [Gitlab Releases Page](https://mad-srv.informatik.uni-erlangen.de/MadLab/GaitAnalysis/gaitmap/-/releases) of this 
 project.
 
-## [2.1.0]
+## [2.1.0] - 2023-02-08
 
 ### Added
 - **HIGHLIGHT**: Finally reworked the HMM branch, added tests and documentation and adapted the API to fit the rest of 
@@ -107,6 +107,14 @@ project.
   dedicated ZUPT algorithms.
   The parameters where deprecated since version 1.5
 
+### Migration Guide
+
+- There are a bunch of small changes that are not backwards compatible.
+  The most important is likely the change to make the `sampling_rate_hz` parameter (and other) keyword only in many 
+  methods.
+  This means, you need to use the parameter name when calling these methods.
+  For example, if you used `detect(data, 100)` before, you now need to use `detect(data, sampling_rate_hz=100)`.
+
 
 ## [2.0.2] - 2022-08-29
 

README.md

@@ -24,14 +24,14 @@ 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).
+For a stable experience install one of our releases (e.g. 2.1).
 
 All new releases (>=2.0) can be found on [Github](https://github.com/mad-lab-fau/gaitmap/releases).
 All old releases are available via MaD-Lab internal [Gitlab](https://mad-srv.informatik.uni-erlangen.de/MadLab/GaitAnalysis/gaitmap/-/releases).
 
 ```
 # gaitmap
-pip install git+https://github.com/mad-lab-fau/gaitmap.git@v2.0.0 --upgrade
+pip install git+https://github.com/mad-lab-fau/gaitmap.git@v2.1.0 --upgrade
 ```
 
 The latest git (bleeding edge) version:

gaitmap/__init__.py

@@ -1,3 +1,3 @@
 """The Gait and Movement Analysis Package."""
 
-__version__ = "2.0.2"
+__version__ = "2.1.0"

gaitmap_mad/gaitmap_mad/__init__.py

@@ -7,4 +7,4 @@
 library.
 Note, that we only support using the exact same version of the gaitmap library.
 """
-__version__ = "2.0.2"
+__version__ = "2.1.0"

gaitmap_mad/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gaitmap_mad"
-version = "2.0.2"
+version = "2.1.0"
 description = "Specific algorithm implementaions by the mad_lab"
 authors = [
     "Arne Küderle <[email protected]>",

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gaitmap"
-version = "2.0.2"
+version = "2.1.0"
 description = "The Gait and Movement Analysis Package - Your definite guide to reliable IMU based human movement analysis."
 authors = [
     "Arne Küderle <[email protected]>",