You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/guides/quick-start.rst
+30-9Lines changed: 30 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,34 @@ You should notice the following new folders:
22
22
23
23
.. image:: /_static/Cheese3DFlowchart.png
24
24
25
+
|
26
+
**Table of contents:**
27
+
28
+
.. contents::
29
+
:local:
30
+
:depth: 2
31
+
:backlinks: none
32
+
25
33
.. _organizing_projects:
26
34
Organizing Cheese3D projects
27
35
----------------------------
28
36
29
-
A Cheese3D project (by default) is self-contained in a folder with the same name as the project.
37
+
A Cheese3D project (by default) is self-contained in a folder with the same name as the project. A typical organization looks like this:
38
+
39
+
.. code-block:: text
40
+
41
+
<project folder (choose this name)>
42
+
|__ config.yaml
43
+
|__ <video recording folder (defaults to "videos")>
44
+
|__ <optional ephys recording folder (defaults to "ephys")>
45
+
|__ model
46
+
| |__ backend <contains the DLC project>
47
+
| |__ labels
48
+
|__triangulation <contains Anipose project; created automatically on 3D stage>
49
+
50
+
.. tip::
51
+
52
+
Store all your Cheese3D projects in a single directory to keep them organized in one place!
30
53
31
54
.. _create_new_project:
32
55
Creating a new project
@@ -75,6 +98,11 @@ Adding video data to the project
75
98
76
99
After clicking "Done" in the dialog, you will be taken to the project interface. To start, you'll be greated by a summary of your project. Here, we find information like the name of the project, the keypoints being tracked on the mouse face, and a list of videos. You should also **find a new** ``cheese3d_demo_project`` **folder in your current working directory** (where you launched the GUI).
From now on, we will refer to files in the ``cheese3d_demo_project`` folder. This always corresponds to the folder you just created using the GUI.
@@ -83,13 +111,6 @@ After clicking "Done" in the dialog, you will be taken to the project interface.
83
111
84
112
Now that your project has been created, you can always return to this screen by running ``cheese3d interactive`` then selecting "Load existing project". Go ahead, try it by pressing ``q`` to quit the app.
A keen-eyed user will notice that there are no videos added to the project!
94
115
95
116
Let's fix that by **copying the** ``cheese3d_demo_data/20231031_chew`` **folder into** ``cheese3d_demo_project/videos`` (you need to create the ``videos`` sub-directory).
@@ -104,7 +125,7 @@ Next, **go back to the GUI and click on the "select sessions" tab at the top men
104
125
.. note::
105
126
Every time you choose a new set of sessions, the project ``config.yaml`` file will be overwritten with the new selections automatically.
106
127
107
-
**Returning to the project "summary" tab**, we see that the project has been reloaded from disk automatically. And we have multiple sessions listed in the "Project sessions" section of the summary.
128
+
**Returning to the project "summary" tab**, we see that the project has been reloaded from disk automatically. And we have multiple sessions listed in the "Project sessions" section of the summary.
0 commit comments