Define the "movement dataset" and reorganise the Getting Started sect…

…ion (#177) * Renamed MoveAccesor class to MovementDataset * WIP describing movement dataset structure and usage * make MovementDataset directly import-able from movement * expanded getting_started and split into multiple pages * document movement info to check install * updated text in homepage cards * standardise code blocks * small formatting fixes * additional formatting and spelling fixes * Apply suggestions from code review Co-authored-by: Chang Huan Lo <[email protected]> * Define abbreviations in supported formats * add note about loading .slp files * d not mention from_dlc_df option * backtick for movement-env * fixed xarray terminology link --------- Co-authored-by: Chang Huan Lo <[email protected]>
neuroinformatics-unit · May 15, 2024 · 3542b29 · 3542b29
1 parent ae702ad
commit 3542b29
Show file tree

Hide file tree

Showing 15 changed files with 477 additions and 378 deletions.
diff --git a/docs/source/api_index.rst b/docs/source/api_index.rst
@@ -71,13 +71,13 @@ Analysis
     cart2pol
     pol2cart
 
-Move Accessor
--------------
+MovementDataset
+---------------
 .. currentmodule:: movement.move_accessor
 .. autosummary::
     :toctree: api
 
-    MoveAccessor
+    MovementDataset
 
 Logging
 -------

diff --git a/docs/source/getting_started.md b/docs/source/getting_started.md
diff --git a/docs/source/getting_started/index.md b/docs/source/getting_started/index.md
@@ -0,0 +1,22 @@
+# Getting Started
+
+Start by [installing the package](installation.md).
+
+After that try [loading some of your own predicted poses](target-loading),
+from one of the [supported formats](target-formats).
+Alternatively, you can use the [sample data](target-sample-data)
+provided with the package.
+
+Once you have loaded some data, feel free to explore the structure and
+usage of [movement datasets](movement_dataset.md), which are a central
+concept in the package.
+
+```{toctree}
+:maxdepth: 2
+:caption: Contents
+
+installation
+input_output
+sample_data
+movement_dataset
+```