Merge pull request #150 from kabilar/main

Add Kilosort, NWB, and DANDI citations

Author: dimitri-yatsenko

CHANGELOG.md

@@ -3,6 +3,11 @@
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
  [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
+## [0.2.10] - 2023-05-22
+
++ Add - Kilosort, NWB, and DANDI citations
++ Update - mkdocs.yaml
+
 ## [0.2.9] - 2023-05-11
 
 + Fix - `.ipynb` dark mode output for all notebooks.
@@ -113,6 +118,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 + Add - Probe table supporting: Neuropixels probes 1.0 - 3A, 1.0 - 3B, 2.0 - SS,
   2.0 - MS
 
+[0.2.10]: https://github.com/datajoint/element-array-ephys/releases/tag/0.2.10
 [0.2.9]: https://github.com/datajoint/element-array-ephys/releases/tag/0.2.9
 [0.2.8]: https://github.com/datajoint/element-array-ephys/releases/tag/0.2.8
 [0.2.7]: https://github.com/datajoint/element-array-ephys/releases/tag/0.2.7

docs/.docker/pip_requirements.txt

@@ -8,4 +8,5 @@ mkdocs-gen-files
 mkdocs-literate-nav
 mkdocs-exclude-search
 mkdocs-markdownextradata-plugin
-mkdocs-jupyter
+mkdocs-jupyter
+mkdocs-section-index

docs/mkdocs.yaml

@@ -97,9 +97,6 @@ theme:
 plugins:
   - markdownextradata: {}
   - search
-  # - redirects: # OPTIONAL REDIRECTS
-  #     redirect_maps:
-  #       "index.md": "getting_started.md"
   - mkdocstrings:
       default_handler: python
       handlers:
@@ -118,6 +115,7 @@ plugins:
         - "*/navigation.md"
   - mkdocs-jupyter:
       ignore_h1_titles: True
+  - section-index
 markdown_extensions:
   - attr_list
   - toc:

docs/src/citation.md

@@ -1,11 +1,19 @@
 # Citation
 
-If your work uses this Element, please cite the following manuscript and Research
-Resource Identifier (RRID):
+If your work uses the following resources, please cite the respective manuscript and/or Research Resource Identifier (RRID):
 
-+ Yatsenko D, Nguyen T, Shen S, Gunalan K, Turner CA, Guzman R, Sasaki M, Sitonic D,
-  Reimer J, Walker EY, Tolias AS. DataJoint Elements: Data Workflows for
-  Neurophysiology. bioRxiv. 2021 Jan 1. doi: https://doi.org/10.1101/2021.03.30.437358
++ DataJoint Element Array Electrophysiology - Version {{ PATCH_VERSION }}
+  + Yatsenko D, Nguyen T, Shen S, Gunalan K, Turner CA, Guzman R, Sasaki M, Sitonic D,
+    Reimer J, Walker EY, Tolias AS. DataJoint Elements: Data Workflows for
+    Neurophysiology. bioRxiv. 2021 Jan 1. doi: https://doi.org/10.1101/2021.03.30.437358
 
-+ DataJoint Elements ([RRID:SCR_021894](https://scicrunch.org/resolver/SCR_021894)) -
-  Element Array Electrophysiology (version {{ PATCH_VERSION }})
+  + [RRID:SCR_021894](https://scicrunch.org/resolver/SCR_021894)
+
++ Kilosort
+  + [Manuscripts](https://github.com/MouseLand/Kilosort#citation-requirement).
+
++ NWB
+  + [Manuscript](https://www.nwb.org/publications/)
+
++ DANDI
+  + [Citation options](https://www.dandiarchive.org/handbook/10_using_dandi/#citing-dandi)

element_array_ephys/version.py

@@ -1,2 +1,2 @@
 """Package metadata."""
-__version__ = "0.2.9"
+__version__ = "0.2.10"