-
Notifications
You must be signed in to change notification settings - Fork 370
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 new options for installation and improve instructions for NEST #1262
Add new options for installation and improve instructions for NEST #1262
Conversation
Looks great! Thanks a lot for this. Minor comments:
is a bit confusing; I'd prefer to split the two commands to make it explicit that the latter is run in the python shell.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My review comments are now contained in a PR against your branch. Sorry again for this taking a century.
Remove superfluous files and streamline new installation documentation in general
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many thanks. I really think this is a huge improvement for getting started.
This pull request incorporates several changes to the 'onboarding and installation-related' pages of documentation.
This includes new instructions for several 'package managers', a troubleshooting section, and a modified getting-started page. See output here: https://nest-test.readthedocs.io/en/improve_installation/installation/index.html
2.1) Standard install include the Ubuntu PPA, docker, Conda and the live media (windows)
2.2) Advanced install includes a
There is also a troubleshooting page that tries to cover the main issues people have when installing nest, namely environment and package issues.
We regularly have questions from users because of misunderstandings with installation environments. The idea with the troubleshooting page is to have a place to point people when these questions arise, that hopefully provide some useful tips, so they can fix their environment.
@terhorstd and I have discussed this, and we think the troubleshooting page could be a separate entity from a FAQ page, where the FAQ is focused on NEST specific questions and the troubleshooting page is aimed at system or environment issues.