Document automatic Wayland/Nvidia workaround in troubleshooting#1033
Document automatic Wayland/Nvidia workaround in troubleshooting#1033niksirbi wants to merge 3 commits into
Conversation
napari now sets QT_QPA_PLATFORM=xcb and PYOPENGL_PLATFORM=glx automatically at startup, so explain that most users need no action, and document the manual workaround for the IPython/Jupyter case where a Qt application is created before napari is imported. Add a stable (wayland-and-nvidia) anchor that the in-app warning links to, while keeping the original heading. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
TimMonko
left a comment
There was a problem hiding this comment.
Absolutely lovely! Thank you!!!! 🤩
I left two comments, but you are more then welcome to do with them as you please. :)
Co-authored-by: Tim Monko <timmonko@gmail.com>
|
Thanks both! Probably it make sense to wait till we settle on how napari/napari#9009 lands before this one gets merged, right? |
Yep! And because you have the "Depends on" in the OP our CI blocks it :) |
Good to know! I should start using that too. |
|
I pushed an additional commit |
|
Looks great! Thank you for your continued effort and time on this! |
References and relevant issues
Depends on napari/napari#9009
Related to napari/napari#8808
napari/napari#9009 makes napari automatically apply the Wayland/Nvidia startup workaround (setting
QT_QPA_PLATFORM=xcbandPYOPENGL_PLATFORM=glx), and adds an in-app warning for the cases it can't cover. That warning links to the troubleshooting section updated here (#wayland-and-nvidia). See that PRfor the full background.
Description
This PR updates the "Running napari on Wayland with Nvidia cards" troubleshooting section to reflect the new automatic workaround in napari/napari#9009:
naparicommand or a Python script) no longer need to do anything.import napari(e.g. in IPython or Jupyter when%gui qtruns first), the user must set the variables themselves before starting the session.(wayland-and-nvidia)=anchor that the in-app warning links to, while keeping the original heading so existing links don't break.