Skip to content

Documentation improvement: description of kernel parameters and randomness in NEST GPU - #141

Merged
gmtiddia merged 19 commits into
nest:mainfrom
gmtiddia:documentation
Oct 7, 2026
Merged

gmtiddia merged 19 commits into
nest:mainfrom
gmtiddia:documentation

Conversation

@gmtiddia

@gmtiddia gmtiddia commented Aug 28, 2026 •

Copy link
Copy Markdown
Collaborator

This PR adds two guides to the documentation: one on randomness in NEST GPU (i.e., the description of the rng seed and how to distribute neuron and synapse parameters in NEST GPU) and one describing the current set of kernel parameters.

Fork documentation version available at the following link: https://nest-gpu-fork.readthedocs.io/en/documentation/guides/index.html

@jhnnsnk jhnnsnk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks! I left a few suggestions for improvement, mostly about adding cross-references to NEST Simulator.

Comment thread doc/htmldoc/guides/randomness_in_nestgpu_simulations.rst
Comment thread doc/htmldoc/guides/randomness_in_nestgpu_simulations.rst
Comment thread doc/htmldoc/guides/randomness_in_nestgpu_simulations.rst
Comment thread doc/htmldoc/guides/randomness_in_nestgpu_simulations.rst Outdated
Comment thread doc/htmldoc/guides/kernel_parameters.rst Outdated
Comment thread doc/htmldoc/guides/kernel_parameters.rst Outdated
Comment thread doc/htmldoc/guides/kernel_parameters.rst
Comment thread doc/htmldoc/guides/kernel_parameters.rst
Comment thread doc/htmldoc/guides/kernel_parameters.rst Outdated
@gmtiddia
gmtiddia requested a review from jhnnsnk September 21, 2026 15:55
@gmtiddia

Copy link
Copy Markdown
Collaborator Author

@jhnnsnk thanks a lot for your suggestions, I've implemented them in the current version!

@jhnnsnk jhnnsnk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good, but could you please also add the default values to all the other kernel parameters?

@gmtiddia
gmtiddia requested a review from jhnnsnk October 7, 2026 09:43
@gmtiddia

gmtiddia commented Oct 7, 2026 •

Copy link
Copy Markdown
Collaborator Author

Hi @jhnnsnk, I've added the default values for all the kernel parameters, thanks for pointing this out!

PS sorry for the numerous commits, but I had to getting used to the new CI checks :)

@gmtiddia

gmtiddia commented Oct 7, 2026

Copy link
Copy Markdown
Collaborator Author

As discussed in our last meeting, I'll merge the PR since I've added the default values for kernel parameters.

@gmtiddia
gmtiddia merged commit 6df8370 into nest:main Oct 7, 2026
3 checks passed
@jhnnsnk

jhnnsnk commented Oct 7, 2026

Copy link
Copy Markdown
Collaborator

Great, thanks!

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.

2 participants