-
Notifications
You must be signed in to change notification settings - Fork 1
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
Conversation
There was a problem hiding this 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.
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:
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). |
Ah, now understand that incredibly annoying error! Build was failing with unpinned
and was fixed by pinning to
so it was trying to use
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!
|
@JoeZiminski I think the general idea is good, with the obvious caveats that:
|
93cb103
to
1502263
Compare
There was a problem hiding this 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!
docs/source/ephys_at_swc/example_pipelines/examples/sara_mederos.py
Outdated
Show resolved
Hide resolved
Co-authored-by: Adam Tyson <code@adamltyson.com>
Co-authored-by: Adam Tyson <code@adamltyson.com>
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
"""
As discussed in #53, this PR adds a 'Electrophysiology' page and changes 'Data Analysis' to 'Behaviour' page. The electrophysiology page has added:
Reviewing:
sphinx-gallery