From c1160d9b70baa0f94e98cfcc997d89d679e2db88 Mon Sep 17 00:00:00 2001 From: Thomas Robitaille Date: Wed, 4 Dec 2024 11:55:31 +0000 Subject: [PATCH] Update pip installation instructions --- doc/installation/pip.rst | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/doc/installation/pip.rst b/doc/installation/pip.rst index 5db87c2c..692a117f 100644 --- a/doc/installation/pip.rst +++ b/doc/installation/pip.rst @@ -6,18 +6,15 @@ Installing with pip You can install glue along with **all** required and optional dependencies with `pip `__ using:: - pip install glueviz[all,qt] + pip install glueviz[qt] The above will include domain-specific plugins as well as the PyQt5 library. -If you only want to install glue with all required and only non-domain-specific -optional dependencies (for example excluding the optional dependencies for -astronomy), you can do:: +If you only want to install glue with minimal dependencies, you can instead +install individual glue packages, e.g.:: - pip install glueviz[recommended,qt] + pip install glue-core # base package with no front-end + pip install glue-qt[qt] # Qt-based front-end + pip install glue-vispy-viewers # 3D viewers -And finally, if you don't want to install optional dependencies at all, and -already have PyQt5 or PySide2 installed, you can do:: - - pip install glueviz - -Note that this will still installed required dependencies. +The ``[qt]`` ensures PyQt5 gets installed, but you can also install PyQt6 or +PySide yourself and miss out the ``[qt]``.