Skip to content

Commit 1c02efb

Browse files
timhoffmtacaswell
andauthored
DOC: Add install instructions for pixi and uv (matplotlib#29752)
* DOC: Add install instructions for pixi and uv Closes matplotlib#29746. Notes on issues with uv an tk taken from astral-sh/uv#6893 (comment) Co-authored-by: Thomas A Caswell <[email protected]>
1 parent d963a55 commit 1c02efb

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

doc/index.rst

+28
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,34 @@ Install
2929
3030
conda install -c conda-forge matplotlib
3131
32+
.. tab-item:: pixi
33+
34+
.. code-block:: bash
35+
36+
pixi add matplotlib
37+
38+
.. tab-item:: uv
39+
40+
.. code-block:: bash
41+
42+
uv add matplotlib
43+
44+
.. warning::
45+
46+
If you install Python with ``uv`` then the ``tkagg`` backend
47+
will not be available because python-build-standalone (used by uv
48+
to distribute Python) does not contain tk bindings that are usable by
49+
Matplotlib (see `this issue`_ for details). If you want Matplotlib
50+
to be able to display plots in a window, you should install one of
51+
the other :ref:`supported GUI frameworks <optional_dependencies>`,
52+
e.g.
53+
54+
.. code-block:: bash
55+
56+
uv add matplotlib pyside6
57+
58+
.. _this issue: https://github.com/astral-sh/uv/issues/6893#issuecomment-2565965851
59+
3260
.. tab-item:: other
3361

3462
.. rst-class:: section-toc

doc/install/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ precompiled wheel for your OS and Python.
2828
The following backends work out of the box: Agg, ps, pdf, svg
2929

3030
Python is typically shipped with tk bindings which are used by
31-
TkAgg.
31+
TkAgg. Notably, python-build-standalone – used by ``uv`` – does
32+
not include tk bindings that are usable by Matplotlib.
3233

3334
For support of other GUI frameworks, LaTeX rendering, saving
3435
animations and a larger selection of file formats, you can

0 commit comments

Comments
 (0)