Skip to content

Commit 7cad4ed

Browse files
author
André Böni
committed
Documentation typos
1 parent 331fa57 commit 7cad4ed

File tree

2 files changed

+5
-10
lines changed

2 files changed

+5
-10
lines changed

README.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,6 @@ Gaitalytics
5151
:alt: GitHub License
5252

5353

54-
55-
56-
57-
5854
.. end-badges
5955
6056
This Python package provides a comprehensive set of tools and advanced algorithms for analyzing 3D motion capture data.
@@ -77,23 +73,22 @@ Fast install with anaconda:
7773
conda install gaitalytics -c DartLab-LLUI
7874
..
7975
76+
.. warning::
77+
| To avoid dependencies issues, make sure conda-forge is the first channel in your conda configuration.
78+
8079
Or with pip:
8180

8281
.. code:: shell
8382
8483
pip install gaitalytics
8584
..
8685
87-
..
88-
89-
.. warning::
90-
| Manual installation of the `pyomeca <https://pyomeca.github.io/>`_ package is required. when using the pip installation method.
9186

9287
Configuration
9388
^^^^^^^^^^^^^
9489

9590
Gaitalytics can be used with any marker set, which at least includes
96-
three or for hip markers (front left/right, back left/right or sacrum) and four foot
91+
three or four hip markers (front left/right, back left/right or sacrum) and four foot
9792
markers (left heel/toe, right heel/toe).
9893

9994
Additionally markers can be defined on which standard time-series features such as min max mean etc.

docs/usage/event_detection.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Following snipped illustrates the usage of the detection function:
2020
2121
config = api.load_config("./config.yaml")
2222
trial = api.load_c3d_trial("./example.c3d", config)
23-
events = api.detect_events(trial)
23+
events = api.detect_events(trial, config)
2424
2525
..
2626

0 commit comments

Comments
 (0)