Align documentation of connection management with connectivity concepts publication #2992
Conversation
Revise connection_management.rst
|
Adjustement is needed when #2955 (tripartite connection rule) is merged. |
|
|
||
| .. admonition:: Availability | ||
| This documentation not only describes how to define network connectivity in NEST, but also represents a living reference for the connection rules defined in the article "Connectivity concepts in neuronal network modeling" [1]_. Deviations from the rules defined in the publication are highlighted in green. |
There was a problem hiding this comment.
@heplesser Shall we add a statement suggesting that the paper could be cited as a permanent reference for a certain rule?
There was a problem hiding this comment.
Yes, that seems like a good idea!
heplesser
added
T: Enhancement
| How to handle created connections | ||
| ================================= |
There was a problem hiding this comment.
| How to handle created connections | |
| ================================= | |
| How to inspect and modify connections | |
| ============================== |
Also in the text below, "already created" sounds strange. Either write "existing connections" or just "connections", because when you talk about inspecting and modifying, that implies that the connections must exist.
| ================================= | ||
|
|
||
| Here, we describe how to inspect and modify already created connections. | ||
| For creating new connections, refer to :ref:`connection_management`, and for parameterizing synapses, see :ref:`synapse_spec`. |
There was a problem hiding this comment.
The parameterization you mean here is the one during creation, isn't it? Then the sentence is confusing. Maybe something like
| For creating new connections, refer to :ref:`connection_management`, and for parameterizing synapses, see :ref:`synapse_spec`. | |
| :ref:`connection_management` describes how to create new connections and :ref:`synapse_spec` how to parameterize synapses as they are created. |
|
@heplesser To inspect the build of the documentation, we need the workflow to run, can we approve and run? |
Done! |
|
@clemensk0 just fyi, I tried to fix a small typo in the hopes that the commit would trigger the Read the docs build. There's seems to be an issue with it atm, which I'm looking into. |
Revise based on PR conversation and recent changes
Remove template, minor edits
Add class and directive to center text in rst
add links and change overview
change heading and restructuring
Adjust the images for top of page and update links
There was a problem hiding this comment.
Thanks @clemensk0 and @jhnnsnk for your contribution to the docs, it's a nice improvement! I have one more PR against @clemensk0 branch to fix some links but I approve this PR
Fix links in docs
|
@clemensk0 can you resolve the conflicts? @jhnnsnk |
|
@clemensk0 Ping! It would also be a good idea to merge NEST master into your branch for this PR. |
This pull request revises the documentation of the connection management based on the connectivity concepts publication Senk et al. (2022): https://doi.org/10.1371/journal.pcbi.1010086
There will be a follow up pull request to the NEST Desktop documentation for the graphical notation introduced in the same publication.
As discussed in the open NEST Developer Conference this documentation shall be a living document. The documentation on network connectivity in NEST now contains Connection management, Synapse specification and How to handle created connections. With this pull request we only focused on the connectivity management and only marginally updated the content of the other pages.
Further improvements:
As reviewers we suggest @heplesser @jessica-mitchell @albada
I prepared this pull request together with @jhnnsnk