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 multi-state neuron models #3069

Draft
wants to merge 31 commits into
base: master
Choose a base branch
from

Conversation

jasperalbers
Copy link
Contributor

This PR proposes to add multi-state neuron models used for studying infection dynamics as described in [1]. Building on the implementation of the binary neuron, these models can be in either of three states: S, I or R.
In particular, three new neuron models are added:

  • the SIS neuron that can only be in states S or I where transitions from I to S are allowed
  • the SIR neuron that can be in all three states S, I or R where transitions from R to S are forbidden
  • the SIRS neuron that can be in all three states S, I or R where transitions from R back to S are allowed
    Their implementation closely follows the example set by the binary neuron.

If these models are deemed interesting enough to be added to the NEST simulator, we (@jasperalbers and @ClaudiaMer) would also add the corresponding documentation and tests. Here, we would be grateful for a pointer to a minimal example of what is required for both documentation and tests if that exists.

[1] https://arxiv.org/abs/2312.14851

jasperalbers and others added 19 commits August 4, 2022 11:17
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
Co-authored-by: ClaudiaMer <claudia.lioba.merger@rwth-aachen.de>
@jasperalbers jasperalbers marked this pull request as draft January 17, 2024 15:10
@terhorstd terhorstd added T: Enhancement New functionality, model or documentation S: Normal Handle this with default priority labels Jan 19, 2024
@terhorstd terhorstd added the I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) label Jan 19, 2024
@terhorstd terhorstd added this to To do in Models via automation Jan 19, 2024
@jasperalbers jasperalbers marked this pull request as ready for review January 19, 2024 12:05
@jessica-mitchell
Copy link
Contributor

Hi @jasperalbers @ClaudiaMer thanks for your contribution!

In terms of documentation:

  • any new model should include a a userdoc segment in the header file (section starts with BeginUserDocs and ends with EndUserDocs). See an example here.
    Note that the section headings need to stay the same, and you should add a list of 'keywords' on the first line as you'll see in other model files. These are used to index the models.
  • To build and preview HTML output of documentation locally see here.
  • We also usually want a PyNEST example script that explains how the new model is used.

Note that we use reStructured text markup

Please don't hesitate to ask if you have further questions :)

@jasperalbers
Copy link
Contributor Author

Thanks for the information regarding the documentation! Before we start to work on this we would like to get confirmation on whether these models will be integrated into NEST or not, just to avoid unnecessary work in case they are deemed as not useful.

@jessica-mitchell
Copy link
Contributor

Thanks for the information regarding the documentation! Before we start to work on this we would like to get confirmation on whether these models will be integrated into NEST or not, just to avoid unnecessary work in case they are deemed as not useful.

Makes sense, I would suggest that the quickest way would be to join the open NEST developer meeting on Monday @ 1130 and we can add it to the agenda :)

@jessica-mitchell jessica-mitchell added this to In progress in Documentation via automation Jan 29, 2024
@jasperalbers
Copy link
Contributor Author

We decided in this week's meeting that the models should be added to NEST. I will mark this PR as a draft until we supply the necessary tests and documentation, at which point it will be ready for review.

@jasperalbers jasperalbers marked this pull request as draft February 1, 2024 08:55
@clinssen clinssen self-requested a review February 22, 2024 16:17
Copy link

Pull request automatically marked stale!

@github-actions github-actions bot added the stale Automatic marker for inactivity, please have another look here label Apr 23, 2024
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 stale Automatic marker for inactivity, please have another look here T: Enhancement New functionality, model or documentation
Projects
Documentation
  
In progress
Models
  
To do
Development

Successfully merging this pull request may close these issues.

None yet

3 participants