Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pip installation instructions #28

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+12 −13
Open

Update pip installation instructions #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1160d9
Update pip installation instructions
astrofrog Dec 4, 2024
d9a1d6f
Use nightly wheels for dev deps
astrofrog Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions doc/installation/pip.rst
View file
Open in desktop
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]``.
Comment on lines +19 to +20
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The ``[qt]`` ensures PyQt5 gets installed, but you can also install PyQt6 or
PySide yourself and miss out the ``[qt]``.
pip install PyQt6 glue-qt # Qt6-based front-end
The ``[qt]`` ensures PyQt5 gets installed and set as the front-end,
but you can also use **instead** an already installed PyQt6 or PySide
front-end, or install it along the glue libraries as above (omitting the ``[qt]``).

Perhaps clarifying the different options a bit better here? Or maybe we should link/refer to the qtpy documentation how the default front-end is picked or prescribed setting QT_API?

6 changes: 4 additions & 2 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ passenv =
HOME
# Set to 1 to get more debug information from PyQt
setenv =
dev: PIP_EXTRA_INDEX_URL = https://pypi.anaconda.org/astropy/simple https://pypi.anaconda.org/liberfa/simple https://pypi.anaconda.org/scientific-python-nightly-wheels/simple
test: QT_DEBUG_PLUGINS = 0
whitelist_externals =
find
Expand Down Expand Up @@ -40,8 +41,9 @@ deps =
pyside65: PySide6==6.5.*
pyside66: PySide6==6.6.*
pyside67: PySide6==6.7.*
dev: git+https://github.com/numpy/numpy
dev: git+https://github.com/astropy/astropy
dev: numpy>=0.0.dev0
dev: scipy>=0.0.dev0
dev: astropy>=0.0.dev0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added these to #26 as well.

lts: astropy==5.0.*
lts: matplotlib==3.5.*
# Pin numpy-lts until permanent solution for #2353/#2428
Expand Down
Loading