Add working with tetrodes doc #4055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

alejoe91 merged 16 commits into SpikeInterface:main from chrishalcrow:add-tetrodes-doc

Jul 28, 2025

Member

chrishalcrow commented Jul 12, 2025 •

edited

Loading

Add PR giving advice about working with tetrodes. Contains

Adding a 2-tetrode ProbeGroup and attaching to the recording (not in place!!!!)
Removing bad channels
Preprocessing by group

Docs: https://spikeinterface--4055.org.readthedocs.build/en/4055/tutorials/forhowto/plot_1_working_with_tetrodes.html

Also the first example of a How To guide that we create as a sphnx-gallery item (but include in the How Tos rather than the Tutorials). Is pretty easy to do!

Closes #1877


          add working with tetrodes file

7a48388

zm711 added documentation Harvard Docathon 2025 labels

chrishalcrow added 2 commits

July 12, 2025 12:39


          make sphinx gallery run but link from how to

6fbd0ac


          respond to zacK

f93580b

zm711 reviewed

View reviewed changes

Member

zm711 left a comment

One comment/typo.

examples/how_to/working_with_tetrodes.py Outdated Show resolved Hide resolved

examples/how_to/working_with_tetrodes.py Outdated Show resolved Hide resolved

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved


          tetrode relative distance comment

b915cc8

chrishalcrow requested a review from zm711

July 13, 2025 13:56

zm711 reviewed

View reviewed changes

Member

zm711 left a comment

One last comment. While you address that I'll look at the actual rendering.

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved

zm711 reviewed

View reviewed changes

Member

zm711 left a comment

functions are rendering with italics. We need to add the :code: tag or maybe `` but I only use :code: so that's why I suggested it.

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved

chrishalcrow and others added 4 commits

July 13, 2025 16:04


          Update examples/tutorials/forhowto/plot_1_working_with_tetrodes.py

a22e3ef

Co-authored-by: Zach McKenzie <[email protected]>


          Update examples/tutorials/forhowto/plot_1_working_with_tetrodes.py

Co-authored-by: Zach McKenzie <[email protected]>


          Update examples/tutorials/forhowto/plot_1_working_with_tetrodes.py

3bf9275

Co-authored-by: Zach McKenzie <[email protected]>


          Update examples/tutorials/forhowto/plot_1_working_with_tetrodes.py

6392b4f

Co-authored-by: Zach McKenzie <[email protected]>

chrishalcrow commented

View reviewed changes

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved


          Update examples/tutorials/forhowto/plot_1_working_with_tetrodes.py

e34622e

zm711 approved these changes

View reviewed changes

Member

zm711 left a comment

Good by me.

alejoe91 added this to the 0.103.0 milestone

alejoe91 reviewed

View reviewed changes

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved

alejoe91 requested changes

View reviewed changes

Member

alejoe91 left a comment

Thanks @chrishalcrow

See my comment about CMR, the rest looks great :)

chrishalcrow and others added 3 commits

July 15, 2025 07:03


          respond to alessio

8ab3e53


          Merge branch 'add-tetrodes-doc' of https://github.com/chrishalcrow/sp…

8fcff87

…ikeinterface into add-tetrodes-doc


          Merge branch 'main' into add-tetrodes-doc

zm711 reviewed

View reviewed changes

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved


          Update examples/tutorials/forhowto/plot_1_working_with_tetrodes.py

bf84469

Co-authored-by: Zach McKenzie <[email protected]>

alejoe91 reviewed

View reviewed changes

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved


          add std as bad channel detection method

fa85e42

chrishalcrow mentioned this pull request

Use sphinx gallery machinery to directly build how-to file #3472

Closed

samuelgarcia reviewed

View reviewed changes

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Show resolved Hide resolved

samuelgarcia reviewed

View reviewed changes

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py Outdated Show resolved Hide resolved


          warn of the dangers of cmr

5534a7e

samuelgarcia reviewed

View reviewed changes

examples/tutorials/forhowto/plot_1_working_with_tetrodes.py

+              # This is still a danger if you have two tetrodes in a bundle, which
+              # might pick up the same spike, but  becomes less dangerous
+              # as the number of tetrodes in your bundle increases.
+              #

Member

samuelgarcia Jul 25, 2025

Genial!


          Merge branch 'main' into add-tetrodes-doc

0840fc6

zm711 approved these changes

View reviewed changes

Member

zm711 left a comment

Still good by me too!

alejoe91 approved these changes

View reviewed changes

samuelgarcia approved these changes

View reviewed changes

alejoe91 merged commit 7a4e8eb into SpikeInterface:main

15 checks passed

chrishalcrow deleted the add-tetrodes-doc branch

July 28, 2025 12:50

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Harvard Docathon 2025