Installing

Note

If you wish to contribute to the project, it’s recommended you install the latest development version.

Contents

Installing an official release

Matplotlib and its dependencies are available as wheel packages for macOS, Windows and Linux distributions:

  1. python -m pip install -U pip
  2. python -m pip install -U matplotlib

Note

The following backends work out of the box: Agg, ps, pdf, svg and TkAgg.

For support of other GUI frameworks, LaTeX rendering, saving animations and a larger selection of file formats, you may need to install additional dependencies.

Although not required, we suggest also installing IPython for interactive use. To easily install a complete Scientific Python stack, see Scientific Python Distributions below.

Test data

The wheels (*.whl) on the PyPI download page do not contain test data or example code.

If you want to try the many demos that come in the Matplotlib source distribution, download the *.tar.gz file and look in the examples subdirectory.

To run the test suite:

  • extract the lib/matplotlib/tests or lib/mpl_toolkits/tests directories from the source distribution;
  • install test dependencies: pytest, Pillow, MiKTeX, GhostScript, ffmpeg, avconv, ImageMagick, and Inkscape;
  • run python -mpytest.

Third-party distributions of Matplotlib

Scientific Python Distributions

Anaconda and Canopy and ActiveState are excellent choices that “just work” out of the box for Windows, macOS and common Linux platforms. WinPython is an option for Windows users. All of these distributions include Matplotlib and lots of other useful (data) science tools.

Linux: using your package manager

If you are on Linux, you might prefer to use your package manager. Matplotlib is packaged for almost every major Linux distribution.

  • Debian / Ubuntu: sudo apt-get install python3-matplotlib
  • Fedora: sudo dnf install python3-matplotlib
  • Red Hat: sudo yum install python3-matplotlib
  • Arch: sudo pacman -S python-matplotlib

Installing from source

If you are interested in contributing to Matplotlib development, running the latest source code, or just like to build everything yourself, it is not difficult to build Matplotlib from source. Grab the latest tar.gz release file from the PyPI files page, or if you want to develop Matplotlib or just need the latest bugfixed version, grab the latest git version, and see Install from source.

The standard environment variables CC, CXX, PKG_CONFIG are respected. This means you can set them if your toolchain is prefixed. This may be used for cross compiling.

  1. export CC=x86_64-pc-linux-gnu-gcc
  2. export CXX=x86_64-pc-linux-gnu-g++
  3. export PKG_CONFIG=x86_64-pc-linux-gnu-pkg-config

Once you have satisfied the requirements detailed below (mainly Python, NumPy, libpng and FreeType), you can build Matplotlib.

  1. cd matplotlib
  2. python -mpip install

We provide a setup.cfg file which you can use to customize the build process. For example, which default backend to use, whether some of the optional libraries that Matplotlib ships with are installed, and so on. This file will be particularly useful to those packaging Matplotlib.

Dependencies

Matplotlib requires the following dependencies:

Optionally, you can also install a number of packages to enable better user interface toolkits. See What is a backend? for more details on the optional Matplotlib backends and the capabilities they provide.

  • tk (>= 8.3, != 8.6.0 or 8.6.1): for the Tk-based backends;
  • PyQt4 (>= 4.6) or PySide (>= 1.0.3): for the Qt4-based backends;
  • PyQt5: for the Qt5-based backends;
  • PyGObject: for the GTK3-based backends;
  • wxpython (>= 4): for the WX-based backends;
  • cairocffi (>= 0.8) or pycairo: for the cairo-based backends;
  • Tornado: for the WebAgg backend;

For better support of animation output format and image file formats, LaTeX, etc., you can install the following:

Note

Matplotlib depends on non-Python libraries.

On Linux and OSX, pkg-config can be used to find required non-Python libraries and thus make the install go more smoothly if the libraries and headers are not in the expected locations.

If not using pkg-config (in particular on Windows), you may need to set the include path (to the FreeType, libpng, and zlib headers) and link path (to the FreeType, libpng, and zlib libraries) explicitly, if they are not in standard locations. This can be done using standard environment variables — on Linux and OSX:

Note

The following libraries are shipped with Matplotlib:

  • Agg: the Anti-Grain Geometry C++ rendering engine;
  • qhull: to compute Delaunay triangulation;
  • ttconv: a TrueType font utility.

Wheel builds using conda packages

This is a wheel build, but we use conda packages to get all the requirements. The binary requirements (png, FreeType,…) are statically linked and therefore not needed during the wheel install.

Set up the conda environment. Note, if you want a qt backend, add pyqt to the list of conda packages.

  1. conda create -n "matplotlib_build" python=3.7 numpy python-dateutil pyparsing tornado cycler tk libpng zlib freetype msinttypes
  2. conda activate matplotlib_build

For building, call the script build_alllocal.cmd in the root folder of the repository:

build_alllocal.cmd

Conda packages

The conda packaging scripts for Matplotlib are available at https://github.com/conda-forge/matplotlib-feedstock.

© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
Last updated on Feb 09, 2020. Created using Sphinx 1.8.5. Doc version v3.1.3-2-g782f6ef56.

Installing — Matplotlib 3.1.3 documentation - 图1

原文

提供更好的翻译建议