Skip to content

Commit 644a114

Browse files
committed
Add documentation for ephys modules
1 parent 91950b0 commit 644a114

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,26 @@ ephys pipeline.
1616

1717
## Element architecture
1818

19-
![element-array-ephys diagram](images/attached_array_ephys_element.svg)
19+
`element-array-ephys` is comprised of two schemas, `probe` and `ephys`. To handle
20+
several use cases of this pipeline, we have designed several `ephys` schemas, including
21+
`ephys_acute`, `ephys_chronic`, and `ephys_precluster`.
22+
23+
+ `ephys_acute` - A probe(s) is inserted into a new location during each session.
24+
25+
+ `ephys_chronic` - A probe(s) is inserted once and used to record across multiple
26+
sessions.
27+
28+
+ `ephys_precluster` - A probe(s) is inserted into a new location during each session.
29+
And pre-clustering steps (e.g. CatGT) are performed on the data from each probe prior
30+
to Kilosort analysis.
31+
32+
### `ephys_acute` module
33+
![element-array-ephys acute diagram](images/attached_array_ephys_element_acute.svg)
34+
35+
### `ephys_precluster` module
36+
![element-array-ephys precluster diagram](
37+
images/attached_array_ephys_element_precluster.svg)
38+
2039

2140
As the diagram depicts, the array ephys element starts immediately downstream from `Session`,
2241
and also requires some notion of `Location` as a dependency for `InsertionLocation`. We

0 commit comments

Comments
 (0)