qiime2 / docs

https://docs.qiime2.org
BSD 3-Clause "New" or "Revised" License
21 stars 58 forks source link

imp: adding M1 chip macOS install instructions #544

Closed lizgehret closed 1 year ago

lizgehret commented 1 year ago

This PR adds an install tab with instructions for macOS users with an M1 chip.

lizgehret commented 1 year ago

Preview of local docs build: Screen Shot 2022-10-06 at 10 23 48 AM

Note that the conda activate qiime2-2022.8 line has been updated to include the dev cycle epoch (2022.11). This screenshot was taken before that commit was pushed up (commit SHA f30dab0).

Screen Shot 2022-10-06 at 10 24 03 AM

ebolyen commented 1 year ago

Any chance we can limit our tab length at this point so we can fit more in one line?

lizgehret commented 1 year ago

Any chance we can limit our tab length at this point so we can fit more in one line?

* OS X (64-bit)

* OS X (M1)

* Linux (64-bit)

* Windows Subsystem for Linux (64-bit)

Good idea @ebolyen, this looks much better: Screen Shot 2022-10-06 at 11 28 06 AM

lizgehret commented 1 year ago

Update with clean-up block:

Screen Shot 2022-10-12 at 1 56 31 PM

thermokarst commented 1 year ago

Food for thought - the "M1" instructions should just be the OS X instructions, period. Maybe people don't need to know which processor type they have (edit: I mean "right now" - since arm builds don't exist, the distinction between the two macos build types isn't particularly interesting or informative), and the two commands are functionally identical. Also, there are other apple silicon processors besides "M1" - making this a bit more confusing for those folks.

https://en.wikipedia.org/wiki/Apple_silicon#M_series

ebolyen commented 1 year ago

I suppose that's true, although maybe someday we might have osx-arm64 and osx-64 builds as independent things. So I don't know if the separate tab is harmful (it seems like it could clarify things in a similar way as the WSL tab).

thermokarst commented 1 year ago

This feels like a premature optimization to me, but either way, M2 apple silicon is out now, so calling these the "M1" instructions might not be particularly clarifying either, FWIW.

thermokarst commented 1 year ago

Relevant PR for the M2 discussion here: https://github.com/qiime2/docs/pull/545