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 a section in installation docs about running NEST with EBRAINS #3121

Merged
merged 9 commits into from
Mar 7, 2024

Conversation

jessica-mitchell
Copy link
Contributor

@jessica-mitchell jessica-mitchell commented Feb 29, 2024

This PR, as discussed in docathon with @clinssen @steffengraber @heplesser @ddahmen , adds the try it on ebrains button for an installation free option in the install section.

Note that the links directly takes the person to a one neuron example (assuming they are logged and have server running). The reason: all the examples will be loaded, and the kernel that contains NEST should be set. So less changes for user.
We would need to add additional instructions if we want to open a plain notebook on EBRAINS, which is another possibility.

Missing from the instructions so far (wip in another branch, but can be added here) is this issues that you have to basically click twice to load an example if you dont have a server running yet.

#3066 #3067 should be merged first!

See output for Read the Docs here

@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 29, 2024
@jessica-mitchell jessica-mitchell added the P: Blocked Work on this can not continue, see comments for the particular reason label Feb 29, 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.

@jessica-mitchell Looks good, just a few small suggestions.

doc/htmldoc/index.rst Outdated Show resolved Hide resolved
doc/htmldoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/htmldoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/htmldoc/installation/index.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@steffengraber steffengraber left a comment

Choose a reason for hiding this comment

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

Overall a good step forward for the documentation.
Only have a few comments.

doc/htmldoc/installation/docker.rst Outdated Show resolved Hide resolved
doc/htmldoc/installation/hpc_install.rst Outdated Show resolved Hide resolved
doc/htmldoc/installation/index.rst Show resolved Hide resolved
doc/htmldoc/installation/user.rst Outdated Show resolved Hide resolved
@steffengraber steffengraber self-requested a review March 4, 2024 06:29
@jessica-mitchell jessica-mitchell removed the P: Blocked Work on this can not continue, see comments for the particular reason label Mar 4, 2024
jessica-mitchell and others added 3 commits March 4, 2024 13:17
Co-authored-by: Hans Ekkehard Plesser <hans.ekkehard.plesser@nmbu.no>
Co-authored-by: Hans Ekkehard Plesser <hans.ekkehard.plesser@nmbu.no>
Copy link
Contributor

@steffengraber steffengraber left a comment

Choose a reason for hiding this comment

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

+1

@jessica-mitchell jessica-mitchell merged commit a392eb9 into nest:master Mar 7, 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
Development

Successfully merging this pull request may close these issues.

3 participants