Skip to content

Commit c530671

Browse files
committed
Update readme
1 parent d1cf13f commit c530671

File tree

1 file changed

+37
-9
lines changed

1 file changed

+37
-9
lines changed

README.md

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,40 @@
1-
# DataJoint Element - Array Electrophysiology Element
1+
[![PyPI version](https://badge.fury.io/py/element-array-ephys.svg)](http://badge.fury.io/py/element-array-ephys)
22

3-
DataJoint Element for extracellular array electrophysiology. DataJoint Elements
4-
collectively standardize and automate data collection and analysis for neuroscience
5-
experiments. Each Element is a modular pipeline for data storage and processing with
6-
corresponding database tables that can be combined with other Elements to assemble a
7-
fully functional pipeline.
3+
# DataJoint Element for Extracellular Electrophysiology
84

9-
![diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/diagram_flowchart.svg)
5+
DataJoint Element for extracellular array electrophysiology that processes data
6+
acquired with a polytrode probe
7+
(e.g. [Neuropixels](https://www.neuropixels.org), Neuralynx) using the
8+
[SpikeGLX](https://github.com/billkarsh/SpikeGLX) or
9+
[OpenEphys](https://open-ephys.org/gui) acquisition software and processed with
10+
[MATLAB-based Kilosort](https://github.com/MouseLand/Kilosort) or [python-based
11+
Kilosort](https://github.com/MouseLand/pykilosort) spike sorting software. DataJoint
12+
Elements collectively standardize and automate data collection and analysis for
13+
neuroscience experiments. Each Element is a modular pipeline for data storage and
14+
processing with corresponding database tables that can be combined with other Elements
15+
to assemble a fully functional pipeline.
1016

11-
Installation and usage instructions can be found at the
12-
[Element documentation](https://datajoint.com/docs/elements/element-array-ephys).
17+
## Experiment flowchart
18+
19+
![flowchart](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/diagram_flowchart.svg)
20+
21+
## Data Pipeline Diagram
22+
23+
![datajoint](https://raw.githubusercontent.com/datajoint/workflow-array-ephys/main/images/attached_array_ephys_element.svg)
24+
25+
26+
## Getting Started
27+
28+
+ Install from PyPI
29+
30+
```bash
31+
pip install element-array-ephys
32+
```
33+
34+
+ [Interactive tutorial on GitHub Codespaces](https://github.com/datajoint/workflow-array-ephys#interactive-tutorial)
35+
36+
+ [Documentation](https://datajoint.com/docs/elements/element-array-ephys)
37+
38+
## Support
39+
40+
+ If you need help getting started or run into any errors, please contact our team by email at support@datajoint.com.

0 commit comments

Comments
 (0)