Skip to content

DOC: Add install instructions for pixi and uv #29752

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.

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

Merged
merged 3 commits into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,34 @@ Install

conda install -c conda-forge matplotlib

.. tab-item:: pixi

.. code-block:: bash

pixi add matplotlib

.. tab-item:: uv

.. code-block:: bash

uv add matplotlib

.. warning::

If you install Python with ``uv`` then the ``tkagg`` backend
will not be available because python-build-standalone (used by uv
to distribute Python) does not contain tk bindings that are usable by
Matplotlib (see `this issue`_ for details). If you want Matplotlib
to be able to display plots in a window, you should install one of
the other :ref:`supported GUI frameworks <optional_dependencies>`,
e.g.

.. code-block:: bash

uv add matplotlib pyside6

.. _this issue: https://github.com/astral-sh/uv/issues/6893#issuecomment-2565965851

.. tab-item:: other

.. rst-class:: section-toc
Expand Down
3 changes: 2 additions & 1 deletion doc/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ precompiled wheel for your OS and Python.
The following backends work out of the box: Agg, ps, pdf, svg

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

For support of other GUI frameworks, LaTeX rendering, saving
animations and a larger selection of file formats, you can
Expand Down
Loading