Skip to content

Commit

Permalink
Update pip installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
astrofrog committed Dec 4, 2024
1 parent 8a1d6ab commit c1160d9
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions doc/installation/pip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,15 @@ Installing with pip
You can install glue along with **all** required and optional dependencies
with `pip <https://pip.pypa.io/en/stable/>`__ 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]``.

0 comments on commit c1160d9

Please sign in to comment.