Skip to content

Commit

Permalink
Some modifications for Github and version bump to 2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
AKuederle committed Jul 25, 2022
1 parent 36a4130 commit c944008
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 16 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand All @@ -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/[email protected] --upgrade
# gaitmap_mad
pip install "git+https://mad-srv.informatik.uni-erlangen.de/MadLab/GaitAnalysis/[email protected]#subdirectory=gaitmap_mad" --upgrade
pip install git+https://github.com/mad-lab-fau/[email protected] --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.
<!-- To install the package using poetry, make sure you use a version newer than 1.2.0b2.
This is the first version of poetry that supports subdirectories for git dependencies.
Note, that even then, there are a couple of bugs with poetry`s subdirectory support.
Hence, we would recommend to use the package versions of gaitmap and gaitmap_mad and not install them from source.
Hence, we would recommend to use the package versions of gaitmap and gaitmap_mad and not install them from source. -->

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

Expand Down
2 changes: 1 addition & 1 deletion gaitmap/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""The Gait and Movement Analysis Package."""

__version__ = "1.7.0"
__version__ = "2.0.0"
2 changes: 1 addition & 1 deletion gaitmap_mad/gaitmap_mad/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
2 changes: 1 addition & 1 deletion gaitmap_mad/pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>",
Expand Down
6 changes: 5 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>",
Expand All @@ -13,6 +13,10 @@ authors = [
"Liv Herzer <[email protected]>",
"Felix Kluge <[email protected]>"
]
packages = [
{ include = "gaitmap" },
{ include = "gaitmap_mad", from = "gaitmap_mad"}
]

[tool.poetry.dependencies]
python = ">=3.8.0,<3.11"
Expand Down

0 comments on commit c944008

Please sign in to comment.