Skip to content
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.

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

Add 'Electrophysiology' page. #55

Merged
merged 83 commits into from
Feb 3, 2025
Merged

Add 'Electrophysiology' page. #55

merged 83 commits into from
Feb 3, 2025

Conversation

JoeZiminski
Copy link
Member

@JoeZiminski JoeZiminski commented May 15, 2024

As discussed in #53, this PR adds a 'Electrophysiology' page and changes 'Data Analysis' to 'Behaviour' page. The electrophysiology page has added:

  • getting started - quick overview on resources to get started
  • examples - python and matlab code from researchers in the building for analysing ephys data
  • community - some links to various community resources
  • resources - list of interesting reading.

Reviewing:

  • I think the changes to the website-generation machinery are quite minimal, bar adding sphinx-gallery
  • I am interested to know if the text reads okay and example pipeline blurbs are clear. It might easiest to build to read for review.
  • @neuroinformatics-unit/behaviour this rearranges the way the behaviour section is displayed, let me know if you have any feedback / don't like it.

@JoeZiminski JoeZiminski changed the title Add 'Ephys at the SWC' page. Add 'Electrophysiology at the SWC' page. May 15, 2024
@JoeZiminski JoeZiminski marked this pull request as draft May 15, 2024 11:27
Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is excellent @JoeZiminski, I think this will be incredibly useful for SWC (and other) researchers. I have some minor comments, and I think the roadmap should be moved out of this website.

@JoeZiminski
Copy link
Member Author

Hey @adamltyson I've added a very rough version of the example pipelines just to get an idea of the layout. Basically the type of pipeline in use in the building that it would be nice to include roughly falls into three categories:

  1. spikeinterface scripts for preprocessing and sorting (suitable for sphinx-gallery)
  2. full project repos that use python (often spikeinterface) but are fully integrated with multimodal analysis (e.g. Steve's pipeline)
  3. (2) but for MATLAB pipelines (e.g. Mateo's pipeline)

It seems important to include all three categories on the website (e.g. even though we recommend SI there is a lot of valuable methods in those matlab pipelines). But i'm not sure how best to display the information in a non-clunky way. ATM the front page of the sphinx gallery contains preprocessing/sorting scripts in the usual gallery way, but also links to two other pages detailing python and matlab repos. Do you think this works? (and the general approach, giving some backround of named researchers, their setups and studies).

@JoeZiminski
Copy link
Member Author

Ah, now understand that incredibly annoying error! Build was failing with unpinned sphinx with the below error. I was lazily ignoring warnings because it was building fine locally, I think because I had contaminated my env with ipykernel. However CI was failing with the below error:

Notebook error:
NoSuchKernel in ephys_at_swc/gallery/sara_mederos.ipynb:
No such kernel named python3

and was fixed by pinning to sphinx<7.2. The problem was I ignored the following error in latest shpinx:

WARNING: multiple files found for the document "ephys_at_swc/gallery/sara_mederos": ['ephys_at_swc/gallery/sara_mederos.py', 'ephys_at_swc/gallery/sara_mederos.ipynb', 'ephys_at_swc/gallery/sara_mederos.rst']
Use '/Users/joeziminski/git_repos/HowTo/docs/source/ephys_at_swc/gallery/sara_mederos.ipynb' for the build.

so it was trying to use .ipynb for the build by default in later sphinx. In earlier sphinx, it uses the .rst by default:

WARNING: multiple files found for the document "ephys_at_swc/gallery/sara_mederos": ['ephys_at_swc/gallery/sara_mederos.py', 'ephys_at_swc/gallery/sara_mederos.ipynb', 'ephys_at_swc/gallery/sara_mederos.rst']
Use '/Users/joeziminski/git_repos/HowTo/docs/source/ephys_at_swc/gallery/sara_mederos.rst' for the build.

and fixing the warning with the below means it builds okay on most recent sphinx 🎉. I guess a good lesson to always fix warnings first even if they seem unrelated to the error!

exclude_patterns = [
   ...
    "ephys_at_swc/gallery/*.ipynb",
    "ephys_at_swc/gallery/*.py",
]

@adamltyson
Copy link
Member

adamltyson commented May 20, 2024

@JoeZiminski I think the general idea is good, with the obvious caveats that:

  • Everyone is properly credited
  • They're happy with this all being online, and they're aware that it's fully public etc.

@JoeZiminski JoeZiminski marked this pull request as ready for review September 16, 2024 17:00
@JoeZiminski JoeZiminski requested a review from a team September 16, 2024 17:39
@JoeZiminski JoeZiminski changed the title Add 'Electrophysiology at the SWC' page. Add 'Electrophysiology' page. Sep 16, 2024
Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @JoeZiminski this is excellent. I've reviewed afresh, sorry if anything I say contradicts my original reviews!

I've left some comments, but I think the main thing to check is conflicts with recent changes to the behavioural guides.

Also, as you mentioned something needs to be done about the private link, either get it made public (ideal) or remove that section for now.

Assuming everyone mentioned is happy for this to be shared, I think this is nearly ready to go!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this info be under "Electrophysiology" directly? Seems strange to have a relatively small amount of info under a new section.

Copy link
Member Author

@JoeZiminski JoeZiminski Feb 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it can just go, it is basically identical to the front page but has a bit on SpikeInterface. The spike interface lines (below) can go at the top of the 'EDIT: resources' page?

"""
We recommend SpikeInterface, an open source community toolkit for extracellular electrophysiology, for preprocessing and spike sorting. To begin building your pipeline, the SpikeInterface documentation is a good starting point.
"""

@JoeZiminski JoeZiminski merged commit caf7b04 into main Feb 3, 2025
3 checks passed
@adamltyson adamltyson deleted the add-ephys-at-swc branch February 4, 2025 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants