Skip to content

Commit ce6adf1

Browse files
committed
Merge branch 'main' of https://github.com/kabilar/element-array-ephys into main
2 parents 09e8a96 + 4ca9b32 commit ce6adf1

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ See [Background](Background.md) for the background information and development t
1717
![element-array-ephys diagram](images/attached_array_ephys_element.svg)
1818

1919
As the diagram depicts, the array ephys element starts immediately downstream from ***Session***,
20-
and also requires some notion of ***Location*** as a dependency for ***InsertionLocation***.
20+
and also requires some notion of ***Location*** as a dependency for ***InsertionLocation***. We
21+
provide an [example workflow](https://github.com/datajoint/workflow-array-ephys/) with a
22+
[pipeline script](https://github.com/datajoint/workflow-array-ephys/blob/main/workflow_array_ephys/pipeline.py)
23+
that models (a) combining this Element with the corresponding [Element-Session](https://github.com/datajoint/element-session)
24+
, and (b) declaring a ***SkullReference*** table to provide Location.
2125

2226
### The design of probe
2327

@@ -74,12 +78,12 @@ To activate the `element-array-ephys`, ones need to provide:
7478
+ schema name for the ephys module
7579
7680
2. Upstream tables
77-
+ Session table
78-
+ SkullReference table (Reference table for InsertionLocation, specifying the skull reference)
81+
+ Session table: A set of keys identifying a recording session (see [Element-Session](https://github.com/datajoint/element-session)).
82+
+ SkullReference table: A reference table for InsertionLocation, specifying the skull reference (see [example pipeline](https://github.com/datajoint/workflow-array-ephys/blob/main/workflow_array_ephys/pipeline.py)).
7983
80-
3. Utility functions
81-
+ get_ephys_root_data_dir()
82-
+ get_session_directory()
84+
3. Utility functions. See [example definitions here](https://github.com/datajoint/workflow-array-ephys/blob/main/workflow_array_ephys/paths.py)
85+
+ get_ephys_root_data_dir(): Returns your root data directory.
86+
+ get_session_directory(): Returns the path of the session data relative to the root.
8387
8488
For more detail, check the docstring of the `element-array-ephys`:
8589

0 commit comments

Comments
 (0)