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

Update documentation for iaf_psc_exp #3084

Merged
merged 10 commits into from
Jun 20, 2024

Conversation

ackurth
Copy link
Contributor

@ackurth ackurth commented Feb 1, 2024

No description provided.

@jessica-mitchell jessica-mitchell added T: Enhancement New functionality, model or documentation S: Normal Handle this with default priority I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Feb 1, 2024
@heplesser heplesser changed the title Updat documentation for iaf_psc_exp Update documentation for iaf_psc_exp Feb 5, 2024
Copy link
Contributor

@heplesser heplesser left a comment

Choose a reason for hiding this comment

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

@ackurth This looks quite good already, but see my inline comments. I would also like to ask for a slight re-ordering of material that you have not touched:

  1. Move the last paragraph before the Parameters section ("For conversion ...") before the note on the time constants.
  2. Put the material on the two different ways in which the model can handle input into a note as well.

models/iaf_psc_exp.h Outdated Show resolved Hide resolved
models/iaf_psc_exp.h Outdated Show resolved Hide resolved
models/iaf_psc_exp.h Outdated Show resolved Hide resolved
models/iaf_psc_exp.h Outdated Show resolved Hide resolved
models/iaf_psc_exp.h Outdated Show resolved Hide resolved
@jessica-mitchell
Copy link
Contributor

Here is link to output on Read the Docs: https://nest-simulator--3084.org.readthedocs.build/en/3084/models/iaf_psc_exp.html

@jessica-mitchell
Copy link
Contributor

@ackurth @heplesser After some discussion with David D. about models, we noticed that in the original model description, it mentions the stochastic use case - which does not appear to be in this version - is that correct?

Spiking in this model can be either deterministic (delta=0) or stochastic (delta > 0). In the stochastic case this model implements a type of spike response model with escape noise

Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

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

thanks @ackurth, just a couple of minor typos

models/iaf_psc_exp.h Outdated Show resolved Hide resolved
models/iaf_psc_exp.h Outdated Show resolved Hide resolved
@heplesser heplesser added this to the NEST 3.8 milestone Jun 20, 2024
Copy link
Contributor

@heplesser heplesser left a comment

Choose a reason for hiding this comment

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

@ackurth Thanks, this is fine now except for the small details @jessica-mitchell has pointed out. Please merge master so that tests will pass.

ackurth and others added 2 commits June 20, 2024 14:13
Co-authored-by: jessica-mitchell <[email protected]>
Co-authored-by: jessica-mitchell <[email protected]>
@jessica-mitchell jessica-mitchell merged commit 6b54392 into nest:master Jun 20, 2024
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Enhancement New functionality, model or documentation
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants