Skip to content

Commit 34c8eb6

Browse files
committed
Tweaks to quick start guide
1 parent 7071b3b commit 34c8eb6

1 file changed

Lines changed: 30 additions & 9 deletions

File tree

docs/source/guides/quick-start.rst

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,34 @@ You should notice the following new folders:
2222

2323
.. image:: /_static/Cheese3DFlowchart.png
2424

25+
|
26+
**Table of contents:**
27+
28+
.. contents::
29+
:local:
30+
:depth: 2
31+
:backlinks: none
32+
2533
.. _organizing_projects:
2634
Organizing Cheese3D projects
2735
----------------------------
2836

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!
3053

3154
.. _create_new_project:
3255
Creating a new project
@@ -75,6 +98,11 @@ Adding video data to the project
7598

7699
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).
77100

101+
.. image:: /_static/demo-images/project-summary.png
102+
:width: 49%
103+
.. image:: /_static/demo-images/project-summary-initial.png
104+
:width: 49%
105+
78106
.. note::
79107

80108
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.
83111

84112
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.
85113

86-
.. image:: /_static/demo-images/project-summary.png
87-
:width: 49%
88-
.. image:: /_static/demo-images/project-summary-initial.png
89-
:width: 49%
90-
91-
|
92-
93114
A keen-eyed user will notice that there are no videos added to the project!
94115

95116
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
104125
.. note::
105126
Every time you choose a new set of sessions, the project ``config.yaml`` file will be overwritten with the new selections automatically.
106127

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.
108129

109130
.. image:: /_static/demo-images/project-summary-after.png
110131

0 commit comments

Comments
 (0)