Skip to content

Commit 738061e

Browse files
author
André Böni
committed
update readme
1 parent a9e614d commit 738061e

File tree

2 files changed

+17
-24
lines changed

2 files changed

+17
-24
lines changed

README.rst

Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,16 @@ Gaitalytics
1111
- |docs|
1212
* - tests
1313
- | |github-actions|
14-
| |codecov|
1514
* - package
1615
- | |version| |wheel| |supported-versions| |supported-implementations|
1716
| |commits-since|
1817
.. |docs| image:: https://readthedocs.org/projects/python-gaitalytics/badge/?style=flat
1918
:target: https://python-gaitalytics.readthedocs.io/
2019
:alt: Documentation Status
2120

22-
.. |github-actions| image:: https://github.com/cereneo-foundation/python-gaitalytics/actions/workflows/github-actions.yml/badge.svg
21+
.. |github-actions| image:: https://github.com/DART-Lab-LLUI/python-gaitalytics/actions/workflows/github-actions.yml/badge.svg
2322
:alt: GitHub Actions Build Status
24-
:target: https://github.com/cereneo-foundation/python-gaitalytics/actions
25-
26-
.. |codecov| image:: https://codecov.io/gh/cereneo-foundation/python-gaitalytics/branch/main/graphs/badge.svg?branch=main
27-
:alt: Coverage Status
28-
:target: https://app.codecov.io/github/cereneo-foundation/python-gaitalytics
23+
:target: https://github.com/DART-Lab-LLUI/python-gaitalytics/actions
2924

3025
.. |version| image:: https://img.shields.io/pypi/v/gaitalytics.svg
3126
:alt: PyPI Package latest release
@@ -43,15 +38,18 @@ Gaitalytics
4338
:alt: Supported implementations
4439
:target: https://pypi.org/project/gaitalytics
4540

46-
.. |commits-since| image:: https://img.shields.io/github/commits-since/cereneo-foundation/python-gaitalytics/v0.1.1.svg
41+
.. |commits-since| image:: https://img.shields.io/github/commits-since/DART-Lab-LLUI/python-gaitalytics/v0.1.0.svg
4742
:alt: Commits since latest release
48-
:target: https://github.com/cereneo-foundation/python-gaitalytics/compare/v0.1.1...main
43+
:target: https://github.com/DART-Lab-LLUI/python-gaitalytics/compare/v0.1.0...main
4944

5045

5146

5247
.. end-badges
5348
54-
.. image:: https://github.com/DART-Lab-LLUI/gaitalytics/blob/27ff8401295c3a05537409deb3982129ed78222c/resources/logos/Gaitalytics_noBackground.pngtox
49+
.. image:: https://github.com/DART-Lab-LLUI/gaitalytics/blob/27ff8401295c3a05537409deb3982129ed78222c/resources/logos/Gaitalytics_noBackground.png
50+
:alt: Gaitalytics Logo
51+
:align: center
52+
:width: 200px
5553

5654
This Python package provides a comprehensive set of tools and advanced algorithms for analyzing 3D motion capture data.
5755
It is specifically designed to process gait data stored in c3d format. Prior to utilizing the features of gaitalytics,
@@ -60,9 +58,7 @@ it is necessary to perform data labeling, modeling, and filtering procedures.
6058
The library's versatility allows it to be adaptable to various marker sets and modeling algorithms,
6159
offering high configurability.
6260

63-
.. note::
64-
65-
Current pre-release is only tested with data acquired with Motek Caren, HBM2 Lower Body Trunk and PIG.
61+
> Current pre-release is only tested with data acquired with Motek Caren, HBM2 Lower Body Trunk and PIG.
6662

6763

6864

@@ -104,7 +100,10 @@ Modelling
104100
+============+============================================+===============================+=========+
105101
| com | creates Center of Mass Marker | | |
106102
+------------+--------------------------------------------+-------------------------------+---------+
107-
| xcom | creates extrapolated Center of Mass Marker | | |
103+
| xcom | creates extrapolated Center of Mass Marker | - belt_speed = 1 : | |
104+
| | | speed of treadmill | |
105+
| | | - dominant_leg_length = 0.1 : | |
106+
| | | length of dominant leg (mm) | |
108107
+------------+--------------------------------------------+-------------------------------+---------+
109108
| cmos | create Continuous Margin of Stability | | |
110109
+------------+--------------------------------------------+-------------------------------+---------+
@@ -171,14 +170,14 @@ Analysis
171170
References
172171
~~~~~~~~~~
173172

174-
[1] Michael D. Lewek et al. (2012), “The influence of mechanically and
173+
[1] Michael D. Lewek et al. (2012), “The influence of mechanically and
175174
physiologically imposed stiff-knee gait patterns on the energy cost of
176-
walking”, vol. 93, no.1, pp. 123-128. Publisher: Archives of Physical
175+
walking”, vol. 93, no.1, pp. 123-128. Publisher: Archives of Physical
177176
Medicine and Rehabilitation.
178177

179178
[2] A. Gouelle and F. Mégrot (2017), “Interpreting spatiotemporal
180179
parameters, symmetry, and variability in clinical gait analysis”,
181-
Handbook of Human Motion pp. 1-20, Publisher: Springer International
180+
Handbook of Human Motion pp. 1-20, Publisher: Springer International
182181
Publishing.
183182

184183
Usage
@@ -248,7 +247,6 @@ Minimal requirements would look like this:
248247
right_cmos: cmos_right
249248
250249
model_mapping:
251-
252250
..
253251
254252
**Warning** Do not rename keys of the minimal setting
@@ -258,16 +256,11 @@ Pipeline
258256

259257
Please take the resources in the `example
260258
folder <https://github.com/DART-Lab-LLUI/python-gaitalytics/tree/defc453f95940db55f6875ae7568949daa1b67d4/examples>`__
261-
for advice. ###
262-
263-
264-
265-
259+
for advice.
266260

267261
Documentation
268262
=============
269263

270-
271264
https://python-gaitalytics.readthedocs.org
272265

273266

45 KB
Loading

0 commit comments

Comments
 (0)