Skip to content

Commit 7c9a175

Browse files
committed
Update tutorial.md with additional comments
1 parent 0340c25 commit 7c9a175

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

tutorial/tutorial.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ A short recording is available [here](https://drive.google.com/file/d/1Q8OT7mxn9
88

99
There are more details on the readme, but in brief:
1010

11-
1. Install an [Anaconda](https://www.anaconda.com/download/) distribution of Python -- Choose **Python 3.8** and your operating system. Note you might need to use an anaconda prompt if you did not add anaconda to the path.
11+
1. Install an [Anaconda](https://www.anaconda.com/download/) distribution of Python -- Choose **Python 3.9** and your operating system. Note you might need to use an anaconda prompt if you did not add anaconda to the path.
1212
2. Open an anaconda prompt / command prompt with `conda` for **python 3** in the path
1313
3. Create a new environment with `conda create --name suite2p python=3.9`.
1414
4. To activate this new environment, run `conda activate suite2p`
1515
5. Install the GUI version with `python -m pip install suite2p[gui]`. If you're on a zsh server, you may need to use `' '` around the suite2p[gui] call: `python -m pip install 'suite2p[gui]'`.
1616
7. Now run `python -m suite2p` and you're all set.
1717
8. Running the command `suite2p --version` in the terminal will print the install version of suite2p.
1818

19-
For additional dependencies, like h5py, NWB, Scanbox, and server job support, use the command `python -m pip install suite2p[io]`.
19+
For additional dependencies, like h5py, NWB, Scanbox, and server job support, use the command `python -m pip install suite2p[io]`. If using the zsh shell, make sure to use `' '` around the suite2p[io].
2020

2121
### 2. Run suite2p on the dataset
2222

@@ -44,7 +44,7 @@ Once suite2p finishes running, you will see the output in the GUI, and you can c
4444
1. Pan = Left-Click + drag
4545
2. Zoom = (Scroll wheel) OR (Right-Click + drag)
4646
3. Full view = Double left-click OR escape key
47-
4. Swap cell = Right-click on the cell
47+
4. Swap ROI label = Right-click on the ROI to changes its label (ie, cell to non-cell).
4848
5. Select multiple cells = (Ctrl + left-click) OR (SHIFT + left-click) AND/OR ("Draw selection" button)
4949

5050
You will see ROIs classified as CELLS on the left, and ROIs classified as NOT CELLS on the right, classified using suite2p's default classifier. You can click on different cells with left-click to see their activity over time
@@ -67,7 +67,7 @@ You can see all the ROIs detected if you go under the Colors bar and set `J: cla
6767

6868
We can build our own classifier but for now we'll be using the built-in classifier or default classifier that was used when we ran suite2p. This was trained using our own manual curation of GCaMP6s imaging of cells in cortex. Let's set the cell probability threshold to 0.25 and click enter. Now most of the elongated, smaller and/or frilly ROIs are on the right side. You can further classify ROIs yourself by right-clicking to flip the ROI to the other side. The assignment of the ROIs is updated each time you click / change the cell probability, and is available in the output file `iscell.npy`.
6969

70-
The ROI statistics are available in `stat.npy`. You can see more info about this [here](https://suite2p.readthedocs.io/en/latest/outputs.html#stat-npy-fields).
70+
The ROI statistics are available in `stat.npy`. You can see more info about this [here](https://suite2p.readthedocs.io/en/latest/outputs.html#stat-npy-fields). To revisit a past run of suite2p, click `File > Load processed data`.
7171

7272
### 6. Signal extraction
7373

@@ -77,4 +77,4 @@ When one cell is selected, the fluorescence, neuropil and deconvolved traces are
7777

7878
You can resize the trace view with the triangle buttons (bigger = ▲, smaller = ▼). If multiple cells are selected, you can vary how much the traces overlap with the +/- buttons. You can select as many cells as you want, but by default only 40 of those will be plotted. You can increase or decrease this number by changing the number in the box below max # plotted.
7979

80-
The "Activity mode" is also used for the [Rastermap](https://github.com/mouseland/rastermap) visualization to explore patterns in the data -- choosing "deconvolved" is recommended. Click on the menu option `Visualizations >> Visualize selected cells`. This will either show selected cells (if you have selected more than one cell), or all cells on the side of the GUI on which you are clicked (e.g. select an ROI on the CELLS side to show all CELLS). This will open up a window to view all the traces. Click `compute rastermap + PCs` and then you'll see in the terminal that Rastermap is running. Once it runs, you'll see groups of neurons that are active together. You can then move the red box and click `show selected cells in GUI` to see which cells are active together. For more options when running Rastermap, run in a terminal with your `suite2p` environment `python -m rastermap` and then drag and drop your `spks.npy` file. See the Rastermap [github](https://github.com/mouseland/rastermap) for more details.
80+
The "Activity mode" is also used for the [Rastermap](https://github.com/mouseland/rastermap) visualization to explore patterns in the data -- choosing "deconvolved" is recommended. Click on the menu option `Visualizations >> Visualize selected cells`. This will either show selected cells (if you have selected more than one cell), or all cells on the side of the GUI on which you are clicked (e.g. select an ROI on the CELLS side to show all CELLS). This will open up a window to view all the traces. Click `compute rastermap + PCs` and then you'll see in the terminal that Rastermap is running. Once it runs, you'll see groups of neurons that are active together. You can then move the red box and click `show selected cells in GUI` to see which cells are active together. For more options when running Rastermap, run in a terminal with your `suite2p` environment `python -m rastermap` and then drag and drop your `spks.npy` file. See the Rastermap [github](https://github.com/mouseland/rastermap) for more details.

0 commit comments

Comments
 (0)