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.

Sign up for GitHub

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

Jump to bottom

MUSIC tutorial on ReadTheDocs needs updating #1495

Closed
stinebuu opened this issue Apr 1, 2020 · 1 comment · Fixed by #1552
Closed

MUSIC tutorial on ReadTheDocs needs updating #1495

stinebuu opened this issue Apr 1, 2020 · 1 comment · Fixed by #1552
Assignees
@sarakonradi
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.
Milestone
NEST 3.0

Comments

@stinebuu
Copy link
Contributor

stinebuu commented Apr 1, 2020

Describe the bug
The MUSIC tutorial on ReadTheDocs is outdated and needs to be updated to fit with NEST 3.0. Especially the MUSIC with SLI documentation, which references subnet and outdated functions like LayoutNetwork. The other pages are outdated as well though.

Screenshots
Looking very quickly at the first Python example in Connect two NEST simulations using MUSIC you can see some of the outdated code:

MUSIC_tutorial
@sarakonradi sarakonradi mentioned this issue Apr 1, 2020
Closed
24 tasks
@terhorstd terhorstd added ZC: Documentation DO NOT USE THIS LABEL I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) ZP: Pending DO NOT USE THIS LABEL S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. labels Apr 2, 2020
@sarakonradi sarakonradi self-assigned this Apr 7, 2020
@sarakonradi
Copy link
Contributor

A brief update:

After discussing this issue with @stinebuu, we figured that the best approach would be to begin updating the code blocks. @stinebuu will give me access once those are up-to-date, so that we can improve the documentation accordingly.

@jougs Do you have any input regarding the MUSIC tutorial's content, and whether or not any parts of the text need to be rewritten? Thanks!

@stinebuu stinebuu removed ZC: Documentation DO NOT USE THIS LABEL ZP: Pending DO NOT USE THIS LABEL labels Apr 17, 2020
@stinebuu stinebuu added this to the NEST 3.0 milestone Apr 20, 2020
@stinebuu stinebuu mentioned this issue Apr 24, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sarakonradi sarakonradi

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
Status: Done
Milestone
NEST 3.0
Development

Successfully merging a pull request may close this issue.

Update MUSIC tutorial stinebuu/nest-simulator
3 participants
@terhorstd @stinebuu @sarakonradi