neuroinformatics-unit / movement

Python tools for analysing body movements across space and time
http://movement.neuroinformatics.dev
BSD 3-Clause "New" or "Revised" License
96 stars 8 forks source link

Write a "quickstart" guide walking through a basic `movement` workflow #284

Open niksirbi opened 1 month ago

niksirbi commented 1 month ago

Is your feature request related to a problem? Please describe. Currently we have a lenghty "Getting Started" guide and many examples for specific tasks. What we lack is a single place to showcase all of movement's flagship issues and how they play together.

Describe the solution you'd like An entry-level "quickstart"/"walkthrough" tutorial that familiarises users to the basics of movement, via learning-by-doing. This should be kind of "end-to-end", e.g. loading -> filtering -> derivatives, with little details on each steps (because they are covered elsewhere. The goal is to give a potential/new uses an impression of what movement can do for them. It will also serve as a representative example for the package's scope.

Additional context If we go forward with this, we may consider renaming the current "Getting Started" guide to "User guide", to avoid confusion with the "Quickstart".