Clarify arm64 macOS (Apple Silicon) installation #89
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
|
@Carreau I'm pretty sure I recall you using an Apple Silicon mac, not sure who else does, which is why I added you here to sanity check. |
I have an Apple Silicon mac, and yes, pip installation fails on it because of PyQt. Full details:Honestly if conda installs work on all platforms, I think it's better to move that chunk of text up above pip & prioritize it as the preferred method. I'd put the stuff about pip down below it as an alternative, with a note warning Apple Silicon users. |
jni
reviewed
Jan 17, 2023
Comment on lines
188
to
190
| *(On arm64 macOS, it is the availability of wheels for these Qt5 backends via pip | ||
| that is the problem. If you provide the backend, for example via conda from conda-forge, | ||
| then you can `pip install napari`, but without the `[all]`.)* |
There was a problem hiding this comment.
Instead of adding this after the fact, I would instead update the line above:
Running
pip install "napari[all]"will install the default framework — currently PyQt5, but this could change in the future.
to something like:
Running `pip install "napari[all]"` will install the default framework —
currently PyQt5, but this could change in the future. (But note: if you
have a Mac machine with Apple Silicon — a processor with a name like
"M1" — see {ref}`note-m1`.)
```{note}
:name: note-m1
For machines with Apple Silicon, pre-compiled PyQt5 or PySide2
[wheels](https://realpython.com/python-wheels/) are not available,
so trying to `pip install napari[all]` will fail. You can install one of
those libraries separately, for example with `conda` or `mamba`,
and then `pip install napari`.
```There was a problem hiding this comment.
@jni I've updated for your comment. Slightly tweaked in a way that made more sense to me.
What do you think @GenevieveBuckley comment to put conda-forge first?
From my year+ it seems like conda vs pip is like religious wars—I'm not sure where we stand, officially. But we do provide instructions for conda envs, so ... 👀
jni
approved these changes
Jan 24, 2023
Czaki
reviewed
Jan 25, 2023
dstansby
reviewed
Jan 30, 2023
|
Thank you @psobolewskiPhD and everyone who participated in review! 🎉 🙏 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR provides the basic update for installation on arm64 macOS (Apple Silicon).
pip install napari[all]doesn't work on this platform due to the lack of pyqt5 wheels on pypi (likewise with pyside2). As a result, I think we should just recommend conda and conda-forge. So this is what I've done here.In the section regarding Qt backends, I clarify the above issue and note that if you provide the backend (e.g. via conda-forge) you can
pip install napari.I'm very open to suggestions for how to better handle that.
Type of change
References
closes #43
Final checklist: