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

Updated/extended macOS install instructions #1297

Merged
merged 2 commits into from
Oct 14, 2019

Conversation

heplesser
Copy link
Contributor

I updated the macOS install instructions to a current gcc version number and added troubleshooting information. I also removed the MacPorts instructions, because they have not been tested for a long time and we have, I believe, currently no-one around who uses MacPorts and could test them.

@heplesser heplesser added T: Enhancement New functionality, model or documentation ZC: Documentation DO NOT USE THIS LABEL ZP: PR Created DO NOT USE THIS LABEL S: High Should be handled next I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Sep 25, 2019
@@ -49,7 +49,7 @@ Manual installation

The clang/clang++ compiler that ships with OS X/macOS does not support OpenMP threads and creates code that fails some tests. You therefore need to use **GCC** to compile NEST under OS X/macOS.

Installation instructions here have been tested under OS X 10.11 *El Capitan* and macOS 10.12 *Sierra* with `Anaconda Python 2 and 3 <https://www.continuum.io/anaconda-overview>`_ and all other dependencies installed via `Homebrew <http://brew.sh>`_. See below for `Manual installation with dependencies from MacPorts`_.
Installation instructions here have been tested under macOS 10.14 *Mojave* with `Anaconda Python 3 <https://www.continuum.io/anaconda-overview>`_ and all other dependencies installed via `Homebrew <http://brew.sh>`_. They should also work with earlier versions of macOS.
Copy link
Contributor

Choose a reason for hiding this comment

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

@heplesser Can you be more explicit here in the steps you took to create this environment?
What about the PyNEST dependencies like numpy, scipy, and matplotlib?
which order did you use (brew install then conda install) ? Do you create a conda environment before installing the dependencies?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have tried different approaches at different times, both with the full Anaconda package and miniconda plus the conda install line shown in the Python section. I did not explicitly create conda environments in all cases I tested, it worked with and without for me. Therefore I have't been more specific here.

Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

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

Many thanks for taking time to fix up this file @heplesser
This is related to the PR #1262 but I think it can stand as its own PR because I didn't do many changes to the mac_install page in that other one.
Just a couple of questions related to this page- should we keep the section on homebrew install of nest (the latest version we have is 2.14)? I would also suggest moving or changing the section Python on Mac and explain clearly what steps need to be taken to install dependencies (see comment above).

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.

I have followed step by step the installation instructions for NEST 2.18.0 on a fresh Mojave installation. Everything worked fine. Also in ipython and jupyter notebook the installed NEST works fine. So 👍 from my side.

@heplesser
Copy link
Contributor Author

@jessica-mitchell Should we replace the Homebrew section with one on how to install from Conda? Given that the Homebrew version is outdated and no longer maintained, I believe (@tammoippen ?), replacing it with instructions to install from Conda would make sense. But since #1262 is on its way, maybe for now we could leave it as it is?

I would also suggest leaving the Python section at the end for now to keep it out of the way. There is a forward link at the start of the document, so users should be able to find it.

@jessica-mitchell
Copy link
Contributor

@heplesser
I don't like the location of this link to the Python on Mac section. It assumes the user will read the entire page and not just skip to a section of interest. I'd like to see a link inside manual installation section regarding the python on mac section.

I would also suggest using a numbered list rather than bullets.

In #1262, the 'pre-packaged' versions (conda, ppa, docker, virtual machine) are separated from the 'compiling from source' directions. So I wouldnt want to add the Conda instructions on this page. I think we can discuss in that PR if we want to change how it's organized. But in the case of homebrew, if it will not be updated and maintained with our releases, I would be for removing it.

Other than that, I think it's good to go

@heplesser
Copy link
Contributor Author

@jessica-mitchell I have removed the Homebrew instructions now, changed the top-level heading to "manual installation" and changed to an enumerated list.

Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

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

Looks good, thanks

@terhorstd terhorstd merged commit f1f0288 into nest:master Oct 14, 2019
@heplesser heplesser deleted the update-osx-instructions branch November 28, 2019 08:51
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: High Should be handled next T: Enhancement New functionality, model or documentation ZC: Documentation DO NOT USE THIS LABEL ZP: PR Created DO NOT USE THIS LABEL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants