Skip to content

Commit 1ea7c89

Browse files
committed
Minor fixes and updates to notebook
1 parent b919ca3 commit 1ea7c89

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

notebooks/tutorial.ipynb

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
"source": [
113113
"### **Activate the DataJoint Pipeline**\n",
114114
"\n",
115-
"This tutorial activates the `ephys-acute.py` module from `element-array-ephys`, along\n",
115+
"This tutorial activates the `ephys_acute.py` module from `element-array-ephys`, along\n",
116116
"with upstream dependencies from `element-animal` and `element-session`. Please refer to the\n",
117117
"[`tutorial_pipeline.py`](./tutorial_pipeline.py) for the source code."
118118
]
@@ -1065,7 +1065,7 @@
10651065
"cell_type": "markdown",
10661066
"metadata": {},
10671067
"source": [
1068-
"Every experimental session produces a set of data files. The purpose of the `SessionDirectory` table is to locate these files. It references a directory path relative to a root directory, defined in `dj.config[\\\"custom\\\"]`. More information about `dj.config` is provided in the [documentation](https://datajoint.com/docs/elements/user-guide/)."
1068+
"Every experimental session produces a set of data files. The purpose of the `SessionDirectory` table is to locate these files. It references a directory path relative to a root directory, defined in `dj.config[\"custom\"]`. More information about `dj.config` is provided in the [documentation](https://datajoint.com/docs/elements/user-guide/)."
10691069
]
10701070
},
10711071
{
@@ -1557,7 +1557,8 @@
15571557
"source": [
15581558
"### **Populate electrophysiology recording metadata**\n",
15591559
"\n",
1560-
"In the upcoming cells, populate the `ephys.EphysRecording` table and its part table `ephys.EphysRecording.EphysFile` will extract and store the recording information from a given experimental session."
1560+
"In the upcoming cells, the `.populate()` method will automatically extract and store the\n",
1561+
"recording metadata for each experimental session in the `ephys.EphysRecording` table and its part table `ephys.EphysRecording.EphysFile`."
15611562
]
15621563
},
15631564
{
@@ -2194,8 +2195,7 @@
21942195
"cell_type": "markdown",
21952196
"metadata": {},
21962197
"source": [
2197-
"Now that we've inserted kilosort parameters into the `ClusteringParamSet` table,\n",
2198-
"we're almost ready to sort our data. DataJoint uses a `ClusteringTask` table to\n",
2198+
"DataJoint uses a `ClusteringTask` table to\n",
21992199
"manage which `EphysRecording` and `ClusteringParamSet` should be used during processing. \n",
22002200
"\n",
22012201
"This table is important for defining several important aspects of\n",
@@ -2235,18 +2235,12 @@
22352235
"metadata": {},
22362236
"source": [
22372237
"The `ClusteringTask` table contains two important attributes: \n",
2238-
"+ `paramset_idx` \n",
2239-
"+ `task_mode` \n",
2240-
"\n",
2241-
"The `paramset_idx` attribute tracks\n",
2242-
"your kilosort parameter sets. You can choose the parameter set using which \n",
2243-
"you want spike sort ephys data. For example, `paramset_idx=0` may contain\n",
2244-
"default parameters for kilosort processing whereas `paramset_idx=1` contains your custom parameters for sorting. This\n",
2245-
"attribute tells the `Processing` table which set of parameters you are processing in a given `populate()`.\n",
2246-
"\n",
2247-
"The `task_mode` attribute can be set to either `load` or `trigger`. When set to `load`,\n",
2248-
"running the processing step initiates a search for exisiting kilosort output files. When set to `trigger`, the\n",
2249-
"processing step will run kilosort on the raw data. "
2238+
"+ `paramset_idx` - Allows the user to choose the parameter set with which you want to\n",
2239+
" run spike sorting.\n",
2240+
"+ `task_mode` - Can be set to `load` or `trigger`. When set to `load`, running the\n",
2241+
" Clustering step initiates a search for existing output files of the spike sorting\n",
2242+
" algorithm defined in `ClusteringParamSet`. When set to `trigger`, the processing step\n",
2243+
" will run spike sorting on the raw data."
22502244
]
22512245
},
22522246
{
@@ -2266,6 +2260,13 @@
22662260
")"
22672261
]
22682262
},
2263+
{
2264+
"cell_type": "markdown",
2265+
"metadata": {},
2266+
"source": [
2267+
"Let's call populate on the `Clustering` table which checks for kilosort results since `task_mode=load`."
2268+
]
2269+
},
22692270
{
22702271
"cell_type": "code",
22712272
"execution_count": 28,

0 commit comments

Comments
 (0)