-
Notifications
You must be signed in to change notification settings - Fork 385
Add detailed neuron documentation #3448
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
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.
Very nice. Thanks a lot @jessica-mitchell. I added a few minor comments on the "Types of neurons" page.
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.
Thanks a lot Jessica for the great work! I only found one additional typo. And the flowchart has two rendering problems: 1. the "Delta t" in the "handle input spikes box" is broken. 2. The numerator of the ratio in the refractoriness box is cut off.
After fixing these two problems, the PR is ready to be merged. Thanks!
Co-authored-by: David Dahmen <d.dahmen@fz-juelich.de>
…tor into neuron-docs
This PR adds 2 new pages detailing neurons in NEST for users to better understand what's available in NEST from a comp neuroscience perspective.
the first page describes the various neuron types
the second page describes the update algorithm for neurons using iaf_psc_alpha as the example.
We use this model as an example as it's one that has extensive documentation updates, and is used as an example in many cases.
Further flowcharts will be considered in the future to describe other model types like rate neurons, but that is for another PR.
This PR focuses on neurons - but there are plans to add synase docs in another PR
See the output here: https://nest-simulator--3448.org.readthedocs.build/en/3448/neurons/neuron_types.html
https://nest-simulator--3448.org.readthedocs.build/en/3448/neurons/neuron_update.html