diff --git a/README.md b/README.md index 4d3d7439..acf92274 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # gaitmap - The Gait and Movement Analysis Package -*gaitmap* provides a set of algorithms to analyse your IMU movement data without getting into your way. +*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. @@ -19,31 +19,31 @@ Its API is designed to mimic `sklearn` to provide you a familiar and elegant int First, install a compatible version of Python. Then you need to install the provided packages. -Gaitmap is split into two packages: `gaitmap` (MIT licenced) and `gaitmap_mad` (AGPL3 licenced). +Gaitmap is split into two packages: `gaitmap` and `gaitmap_mad`. To get access to all available algorithms, you need to install both packages. -For a stable experience install one of our releases (e.g. 1.7.0): +**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](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). -For available versions, see the [release page](https://mad-srv.informatik.uni-erlangen.de/MadLab/GaitAnalysis/gaitmap/-/releases). ``` # gaitmap -pip install git+https://mad-srv.informatik.uni-erlangen.de/MadLab/GaitAnalysis/gaitmap.git@v1.7.0 --upgrade -# gaitmap_mad -pip install "git+https://mad-srv.informatik.uni-erlangen.de/MadLab/GaitAnalysis/gaitmap.git@v1.7.0#subdirectory=gaitmap_mad" --upgrade +pip install git+https://github.com/mad-lab-fau/gaitmap.git@v2.0.0 --upgrade ``` The latest git (bleeding edge) version: ``` # gaitmap -pip install git+https://mad-srv.informatik.uni-erlangen.de/MadLab/GaitAnalysis/gaitmap.git --upgrade -# gaitmap_mad -pip install "git+https://mad-srv.informatik.uni-erlangen.de/MadLab/GaitAnalysis/gaitmap.git#subdirectory=gaitmap_mad" --upgrade +pip install git+https://github.com/mad-lab-fau/gaitmap.git --upgrade ``` -To install the package using poetry, make sure you use a version newer than 1.2.0b2. + If you are planning to make any changes to the library, please refer to the developer section below. diff --git a/gaitmap/__init__.py b/gaitmap/__init__.py index 1a00a80d..38e90e2c 100644 --- a/gaitmap/__init__.py +++ b/gaitmap/__init__.py @@ -1,3 +1,3 @@ """The Gait and Movement Analysis Package.""" -__version__ = "1.7.0" +__version__ = "2.0.0" diff --git a/gaitmap_mad/gaitmap_mad/__init__.py b/gaitmap_mad/gaitmap_mad/__init__.py index e5218f96..d1d00c53 100644 --- a/gaitmap_mad/gaitmap_mad/__init__.py +++ b/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__ = "1.7.0" +__version__ = "2.0.0" diff --git a/gaitmap_mad/pyproject.toml b/gaitmap_mad/pyproject.toml index 5fd74f51..69197581 100644 --- a/gaitmap_mad/pyproject.toml +++ b/gaitmap_mad/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "gaitmap_mad" -version = "1.7.0" +version = "2.0.0" description = "Specific algorithm implementaions by the mad_lab" authors = [ "Arne Küderle ", diff --git a/pyproject.toml b/pyproject.toml index 85248de1..d1db7d53 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "gaitmap" -version = "1.7.0" +version = "2.0.0" description = "The Gait and Movement Analysis Package - Your definite guide to reliable IMU based human movement analysis." authors = [ "Arne Küderle ", @@ -13,6 +13,10 @@ authors = [ "Liv Herzer ", "Felix Kluge " ] +packages = [ + { include = "gaitmap" }, + { include = "gaitmap_mad", from = "gaitmap_mad"} +] [tool.poetry.dependencies] python = ">=3.8.0,<3.11"