-
Notifications
You must be signed in to change notification settings - Fork 372
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
Revise Mac installation instructions #1918
Revise Mac installation instructions #1918
Conversation
…nto mac-installation-instructions
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.
Just a few minor changes from my end.
doc/installation/mac_install.rst
Outdated
|
||
#. Extract the NEST tarball as a subdirectory in that directory or clone NEST from GitHub into a subdirectory: | ||
#. Activate the environment. |
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.
It is better to provide the command to activate the environment here (in case they don't see the conda_tips
page)
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.
Done.
Co-authored-by: Pooja Babu <[email protected]>
…ser/nest-simulator.git into mac-installation-instructions
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.
I suggest to remove the INSTALL
file altogether, as it just replicates the information presented in the installation guide.
doc/installation directory.
@jougs Done, I have minimized INSTALL to just a pointer. |
Co-authored-by: jessica-mitchell <[email protected]>
@jessica-mitchell Thanks for your suggestions, I accepted them all. |
…ser/nest-simulator.git into mac-installation-instructions
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.
Thanks for the work on this @heplesser, everything looks good to me
@pnbabu Could you check if these instructions work for you? |
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.
Very nice! I have added some review comments inline.
Contrary to my first impression, this was not too Mac specific for me.
Co-authored-by: Jochen Martin Eppler <[email protected]>
@jessica-mitchell @sarakonradi @jougs I now changed all nest-related paths to the
They made me wonder the path to precisely what we require here, so I'd leave this unchanged here and make it a separate issue. Also, the Python flag documentation
doesn't even mention the possibility of giving an executable or path; again, not a matter for this PR (see also #1948). |
@jougs Now INSTALL is gone for good :). |
…nto mac-installation-instructions Conflicts: doc/contribute/development_workflow.rst doc/installation/conda_tips.rst doc/installation/hpc_install.rst doc/installation/index.rst doc/installation/linux_install.rst doc/installation/mac_install.rst doc/troubleshooting.rst
Merging master after #1843 was a bit of an effort, I hope I didn't break anyting ;). |
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.
Thanks! I'm fine now.
Regarding the documentation of build flags, I suggest to create another issue/PR to fix that.
This PR provides revised Mac installation instructions and also includes some additional updates to installation guidelines.