Skip to content

Commit 8dd5f29

Browse files
authored
Merge branch 'datajoint:main' into main
2 parents c353400 + 2e63edc commit 8dd5f29

File tree

14 files changed

+124
-106
lines changed

14 files changed

+124
-106
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
3838
+ Add - NWB export function
3939

4040
## [0.1.0b4] - 2021-11-29
41-
### Added
42-
+ Processing with Kilosort and pyKilosort for Open Ephys and SpikeGLX
41+
42+
+ Add - Processing with Kilosort and pyKilosort for Open Ephys and SpikeGLX
4343

4444

4545
## [0.1.0b0] - 2021-05-07

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# DataJoint Element - Array Electrophysiology Element
22

3-
DataJoint Element for extracellular array electrophysiology.
4-
DataJoint Elements collectively standardize and automate data collection and analysis for neuroscience experiments. Each Element is a modular pipeline for data storage and processing with corresponding database tables that can be combined with other Elements to assemble a fully functional pipeline.
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.
8+
9+
![diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/diagram_flowchart.svg)
510

611
Installation and usage instructions can be found at the
712
[Element documentation](datajoint.com/docs/elements/element-array-ephys).
8-
9-
![element-array-ephys diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_acute.svg)

docs/mkdocs.yaml

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ theme:
6868
name: material
6969
custom_dir: src/.overrides
7070
icon:
71-
logo: main/project-logo-black
72-
favicon: assets/images/project-logo-color.png
71+
logo: main/company-logo
72+
favicon: assets/images/company-logo-blue.png
7373
features:
7474
- toc.integrate
7575
- content.code.annotate
@@ -127,44 +127,38 @@ extra:
127127
analytics:
128128
provider: google
129129
property: !ENV GOOGLE_ANALYTICS_KEY
130-
feedback:
131-
title: Was this page helpful?
132-
ratings:
133-
- icon: material/emoticon-happy-outline
134-
name: This page was helpful
135-
data: 1
136-
note: >-
137-
Thanks for your feedback!
138-
- icon: material/emoticon-sad-outline
139-
name: This page could be improved
140-
data: 0
141-
note: >-
142-
Thanks for your feedback!
143130
version:
144131
provider: mike
145132
social:
146133
- icon: main/company-logo
147-
link: https://www.datajoint.com/
148-
- icon: fontawesome/solid/ticket
149-
link: https://support.djneuro.io/portal/en/home
134+
link: https://www.datajoint.com
135+
name: DataJoint
150136
- icon: fontawesome/brands/slack
151137
link: https://datajoint.slack.com
138+
name: Slack
152139
- icon: fontawesome/brands/linkedin
153140
link: https://www.linkedin.com/company/datajoint
141+
name: LinkedIn
154142
- icon: fontawesome/brands/twitter
155-
link: https://twitter.com/DataJointIO
143+
link: https://twitter.com/datajoint
144+
name: Twitter
156145
- icon: fontawesome/brands/github
157146
link: https://github.com/datajoint
147+
name: GitHub
158148
- icon: fontawesome/brands/docker
159149
link: https://hub.docker.com/u/datajoint
150+
name: DockerHub
160151
- icon: fontawesome/brands/python
161152
link: https://pypi.org/user/datajointbot
153+
name: PyPI
162154
- icon: fontawesome/brands/stack-overflow
163155
link: https://stackoverflow.com/questions/tagged/datajoint
156+
name: StackOverflow
164157
- icon: fontawesome/brands/youtube
165158
link: https://www.youtube.com/channel/UCdeCuFOTCXlVMRzh6Wk-lGg
159+
name: YouTube
166160
extra_css:
167161
- assets/stylesheets/extra.css
168162

169163
extra_javascript:
170-
- https://js-na1.hs-scripts.com/23133402.js # HubSpot chatbot
164+
- https://js-na1.hs-scripts.com/23133402.js # HubSpot chatbot
Lines changed: 11 additions & 21 deletions
Loading

docs/src/.overrides/.icons/main/project-logo-black.svg

Lines changed: 0 additions & 22 deletions
This file was deleted.
Loading
Binary file not shown.

docs/src/.overrides/assets/stylesheets/extra.css

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,40 @@
66
--dj-white: #ffffff;
77
}
88

9+
/* footer previous/next navigation */
10+
.md-footer__inner:not([hidden]) {
11+
display: none
12+
}
13+
14+
/* footer social icons */
15+
html a[title="DataJoint"].md-social__link svg {
16+
color: var(--dj-primary);
17+
}
18+
html a[title="Slack"].md-social__link svg {
19+
color: var(--dj-primary);
20+
}
21+
html a[title="LinkedIn"].md-social__link svg {
22+
color: var(--dj-primary);
23+
}
24+
html a[title="Twitter"].md-social__link svg {
25+
color: var(--dj-primary);
26+
}
27+
html a[title="GitHub"].md-social__link svg {
28+
color: var(--dj-primary);
29+
}
30+
html a[title="DockerHub"].md-social__link svg {
31+
color: var(--dj-primary);
32+
}
33+
html a[title="PyPI"].md-social__link svg {
34+
color: var(--dj-primary);
35+
}
36+
html a[title="StackOverflow"].md-social__link svg {
37+
color: var(--dj-primary);
38+
}
39+
html a[title="YouTube"].md-social__link svg {
40+
color: var(--dj-primary);
41+
}
42+
943
[data-md-color-scheme="datajoint"] {
1044
/* ribbon */
1145
/* ribbon + markdown heading expansion */
@@ -29,7 +63,7 @@
2963

3064
/* footer */
3165
/* previous/next text */
32-
--md-footer-fg-color: var(--dj-primary);
66+
/* --md-footer-fg-color: var(--dj-primary); */
3367
}
3468

3569
[data-md-color-scheme="slate"] {
@@ -55,5 +89,5 @@
5589

5690
/* footer */
5791
/* previous/next text */
58-
--md-footer-fg-color: var(--dj-white);
59-
}
92+
/* --md-footer-fg-color: var(--dj-white); */
93+
}

docs/src/concepts.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,17 @@ Over the past few years, several labs have developed DataJoint-based data manage
5555

5656
Each of the DataJoint Elements creates a set of tables for common neuroscience data modalities to organize, preprocess, and analyze data. Each node in the following diagram is a table within the Element or a table connected to the Element.
5757

58-
![element-array-ephys diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_acute.svg)
58+
### `ephys_acute` module
59+
60+
![diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_acute.svg)
61+
62+
### `ephys_chronic` module
63+
64+
![diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_chronic.svg)
65+
66+
### `ephys_precluster` module
67+
68+
![diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_precluster.svg)
5969

6070
### `subject` schema ([API docs](https://datajoint.com/docs/elements/element-animal/api/element_animal/subject))
6171
- Although not required, most choose to connect the `Session` table to a `Subject` table.

docs/src/index.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,29 @@
11
# Element Array Electrophysiology
22

3-
This Element features DataJoint schemas for analyzing extracellular array electrophysiology data acquired with Neuropixels probes and spike sorted using Kilosort spike sorter. Each Element is a modular pipeline for data storage and processing with corresponding database tables that can be combined with other Elements to assemble a fully functional pipeline.
3+
This Element features DataJoint schemas for analyzing extracellular array
4+
electrophysiology data acquired with Neuropixels probes and spike sorted using Kilosort
5+
spike sorter. 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.
8+
9+
![diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/diagram_flowchart.svg)
10+
11+
The Element is comprised of `probe` and `ephys` schemas. Several `ephys` schemas are
12+
developed to handle various use cases of this pipeline and workflow:
413

5-
The Element is comprised of `probe` and `ephys` schemas. Several `ephys` schemas are developed to handle various use cases of this pipeline and workflow:
614
+ `ephys_acute`: A probe is inserted into a new location during each session.
7-
+ `ephys_chronic`: A probe is inserted once and used to record across multiple sessions.
8-
+ `ephys_precluster`: A probe is inserted into a new location during each session. Pre-clustering steps are performed on the data from each probe prior to Kilosort analysis.
9-
+ `ephys_no_curation`: A probe is inserted into a new location during each session and Kilosort-triggered clustering is performed without the option to manually curate the results.
1015

11-
Visit the [Concepts page](./concepts.md) for more information about the use cases of `ephys` schemas and an explanation of the tables. To get started with building your own data pipeline, visit the [Tutorials page](./tutorials.md).
16+
+ `ephys_chronic`: A probe is inserted once and used to record across multiple
17+
sessions.
1218

13-
### `ephys_acute` module
14-
![element-array-ephys-acute diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_acute.svg)
19+
+ `ephys_precluster`: A probe is inserted into a new location during each session.
20+
Pre-clustering steps are performed on the data from each probe prior to Kilosort
21+
analysis.
1522

16-
### `ephys_chronic` module
17-
![element-array-ephys-chronic diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_chronic.svg)
23+
+ `ephys_no_curation`: A probe is inserted into a new location during each session and
24+
Kilosort-triggered clustering is performed without the option to manually curate the
25+
results.
1826

19-
### `ephys_precluster` module
20-
![element-array-ephys-precluster diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_precluster.svg)
27+
Visit the [Concepts page](./concepts.md) for more information about the use cases of
28+
`ephys` schemas and an explanation of the tables. To get started with building your own
29+
data pipeline, visit the [Tutorials page](./tutorials.md).

0 commit comments

Comments
 (0)