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 details on Hodgkin Huxley models, based on asynchronicity discussion #2933

Merged
merged 2 commits into from
Sep 15, 2023

Conversation

jessica-mitchell
Copy link
Contributor

@jessica-mitchell jessica-mitchell commented Sep 11, 2023

Resolves #2910

This PR adds the text from the mailing list discussing asynchronicity in Hodgkin Huxley models.
The text is added to model_details folder, which might not fit there because the other files are Jupyter notebooks
but it is technical info on HH models. The text is linked in each HH model.

See output here: https://nest-simulator--2933.org.readthedocs.build/en/2933/model_details/hh_details.html#hh-details

@jessica-mitchell jessica-mitchell added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. labels Sep 11, 2023
@jessica-mitchell jessica-mitchell added this to In progress in Documentation via automation Sep 11, 2023
doc/htmldoc/model_details/hh_details.rst Outdated Show resolved Hide resolved
doc/htmldoc/model_details/hh_details.rst Outdated Show resolved Hide resolved
doc/htmldoc/model_details/hh_details.rst Outdated Show resolved Hide resolved
doc/htmldoc/model_details/hh_details.rst Outdated Show resolved Hide resolved
doc/htmldoc/model_details/hh_details.rst Outdated Show resolved Hide resolved
Documentation automation moved this from In progress to Review Sep 12, 2023
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.

@jessica-mitchell Thanks! I agree with the comments by @clinssen. I made some further suggestions for improvement. In particular, I would modify the opening. I think my form makes it more comprehensible for a reader.

doc/htmldoc/model_details/hh_details.rst Outdated Show resolved Hide resolved
doc/htmldoc/model_details/hh_details.rst Outdated Show resolved Hide resolved
doc/htmldoc/model_details/hh_details.rst Outdated Show resolved Hide resolved
doc/htmldoc/model_details/hh_details.rst Outdated Show resolved Hide resolved
Co-authored-by: Hans Ekkehard Plesser <hans.ekkehard.plesser@nmbu.no>
Co-authored-by: clinssen <c.linssen@fz-juelich.de>
@heplesser
Copy link
Contributor

@clinssen Could you review this asap so we might include it in the next release?

Copy link
Contributor

@clinssen clinssen left a comment

Choose a reason for hiding this comment

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

Cheers!

@heplesser heplesser merged commit a667177 into nest:master Sep 15, 2023
20 checks passed
Documentation automation moved this from Review to Done Sep 15, 2023
@heplesser heplesser added the I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) label Sep 15, 2023
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: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

Add additional documentaton regarding model Hodgkin Huxley
3 participants