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 spike source docs. #1939

Merged
merged 7 commits into from
Aug 25, 2022

Conversation

thorstenhater
Copy link
Contributor

Explain where spikes come from.

Closes #1647

Copy link
Collaborator

@Helveg Helveg left a comment

Choose a reason for hiding this comment

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

Is there anything reasonable that can be done in the code example to show "oh hey, we have 3 spike detectors, so now we have spikes with id 0-2", that'll show the input output relationship?

@thorstenhater
Copy link
Contributor Author

thorstenhater commented Aug 5, 2022

Yes, @brenthuisman earmarked this for himself. But the gist is, we are going to attach a metadata field to the spike callback, eg location as s-exp string and label string, so you can engage in some filtering. At least in C++ that should work, for Python performance might be an issue.

Although this conflates issues, see here: #1929

@thorstenhater
Copy link
Contributor Author

Fixed: #1941

@thorstenhater
Copy link
Contributor Author

Also, there is a stub in /doc/concepts/decor.rst for this. Maybe move this documentation there, since talking specifically about being placed (should that list of placeables be termified then?). A second (more abstract?) definition of a spike detector might be confusing.

That's the core issue right there, they are both part of the data collection framework and of the networking facilities.
So, where to categorise them? I'd prefer to explain the detector as part of the interconnectivity as that is the topic where
I consider them most important. And then -- of course -- link to data extraction (you know, you can actually write out
those spikes we use to network) and how to set them up (since that's how they come into being).

@brenthuisman
Copy link
Contributor

brenthuisman commented Aug 23, 2022

That's the core issue right there, they are both part of the data collection framework and of the networking facilities. So, where to categorise them?

=> they should be in both places. By adding a link I'll let you get away with adding text just once :) BUT, it would be confusing to have some of them in decor->placeables, and others under interconnectivity. Currently in the former there lives 1. Connection sites and 3. Gap junction connection sites. Could we then move that over too (and replace with links)? And maybe we can add a few lines (to decor->placeables) on the subject of spike detectors that explains their dual use and details their use for the case where people want to get spiking times/counts out?

Copy link
Contributor

@brenthuisman brenthuisman left a comment

Choose a reason for hiding this comment

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

I now approve of this message.

@thorstenhater
Copy link
Contributor Author

I likewise approve your additions ... it's still funny to me that we can circumevent review process this way.

@thorstenhater thorstenhater merged commit 86ad95d into arbor-sim:master Aug 25, 2022
@thorstenhater thorstenhater deleted the doc/spike-recording branch August 25, 2022 19:10
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.

Newb-trap in spike recording docs
3 participants