Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit e04da0a

Browse filesBrowse files
jklymakjklymak
authored
Merge pull request matplotlib#11254 from anntzer/update-installrst
Update INSTALL.rst.
2 parents 103d839 + faabe8c commit e04da0a
Copy full SHA for e04da0a

File tree

Expand file treeCollapse file tree

1 file changed

+45
-42
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+45
-42
lines changed

‎INSTALL.rst

Copy file name to clipboardExpand all lines: INSTALL.rst
+45-42Lines changed: 45 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,25 @@ macOS
3838
To use the native OSX backend you will need :ref:`a framework build
3939
<osxframework-faq>` build of Python.
4040

41-
Test Data
41+
Test data
4242
---------
4343

4444
The wheels (:file:`*.whl`) on the `PyPI download page
4545
<https://pypi.python.org/pypi/matplotlib/>`_ do not contain test data
4646
or example code.
47+
4748
If you want to try the many demos that come in the Matplotlib source
4849
distribution, download the :file:`*.tar.gz` file and look in the
4950
:file:`examples` subdirectory.
51+
5052
To run the test suite:
5153

52-
* extract the :file:`lib/matplotlib/tests` or
53-
:file:`lib/mpl_toolkits/tests` directories from the source distribution;
54-
* install test dependencies: `pytest <https://pypi.python.org/pypi/pytest>`_,
55-
Pillow, MiKTeX, GhostScript, ffmpeg, avconv, ImageMagick, and `Inkscape
56-
<https://inkscape.org/>`_;
57-
* run ``pytest path\to\tests\directory``.
54+
* extract the :file:`lib/matplotlib/tests` or :file:`lib/mpl_toolkits/tests`
55+
directories from the source distribution;
56+
* install test dependencies: `pytest <https://pypi.python.org/pypi/pytest>`_,
57+
Pillow, MiKTeX, GhostScript, ffmpeg, avconv, ImageMagick, and `Inkscape
58+
<https://inkscape.org/>`_;
59+
* run ``python -mpytest``.
5860

5961
Third-party distributions of Matplotlib
6062
=======================================
@@ -68,12 +70,12 @@ Scientific Python Distributions
6870
<https://www.enthought.com/products/canopy/>`_ and `ActiveState
6971
<https://www.activestate.com/activepython/downloads>`_ are excellent
7072
choices that "just work" out of the box for Windows, macOS and common
71-
Linux platforms. `WinPython <https://winpython.github.io/>`__ is an
72-
option for windows users. All of these distributions include
73+
Linux platforms. `WinPython <https://winpython.github.io/>`_ is an
74+
option for Windows users. All of these distributions include
7375
Matplotlib and *lots* of other useful (data) science tools.
7476

75-
Linux : using your package manager
76-
----------------------------------
77+
Linux: using your package manager
78+
---------------------------------
7779

7880
If you are on Linux, you might prefer to use your package manager. Matplotlib
7981
is packaged for almost every major Linux distribution.
@@ -133,57 +135,58 @@ Dependencies
133135

134136
Matplotlib requires the following dependencies:
135137

136-
* `Python <https://www.python.org/downloads/>`_ (>= 3.5)
137-
* `NumPy <http://www.numpy.org>`_ (>= |minimum_numpy_version|)
138-
* `setuptools <https://setuptools.readthedocs.io/en/latest/>`__
139-
* `dateutil <https://pypi.python.org/pypi/python-dateutil>`_ (>= 2.1)
140-
* `pyparsing <https://pyparsing.wikispaces.com/>`__
141-
* `libpng <http://www.libpng.org>`__ (>= 1.2)
142-
* `pytz <http://pytz.sourceforge.net/>`__
143-
* FreeType (>= 2.3)
144-
* `cycler <http://matplotlib.org/cycler/>`__ (>= 0.10.0)
145-
* `kiwisolver <https://github.com/nucleic/kiwi>`__ (>= 1.0.0)
138+
* `Python <https://www.python.org/downloads/>`_ (>= 3.5)
139+
* `NumPy <http://www.numpy.org>`_ (>= |minimum_numpy_version|)
140+
* `setuptools <https://setuptools.readthedocs.io/en/latest/>`_
141+
* `dateutil <https://pypi.python.org/pypi/python-dateutil>`_ (>= 2.1)
142+
* `pyparsing <https://pyparsing.wikispaces.com/>`_
143+
* `libpng <http://www.libpng.org>`_ (>= 1.2)
144+
* `pytz <http://pytz.sourceforge.net/>`_
145+
* `FreeType <https://www.freetype.org/>`_ (>= 2.3)
146+
* `cycler <http://matplotlib.org/cycler/>`_ (>= 0.10.0)
147+
* `six <https://pypi.python.org/pypi/six>`_ (>= 1.10)
148+
* `kiwisolver <https://github.com/nucleic/kiwi>`_ (>= 1.0.0)
146149

147150
Optionally, you can also install a number of packages to enable better user
148151
interface toolkits. See :ref:`what-is-a-backend` for more details on the
149152
optional Matplotlib backends and the capabilities they provide.
150153

151-
* :term:`tk` (>= 8.3, != 8.6.0 or 8.6.1): for the TkAgg backend;
152-
* `PyQt4 <https://pypi.python.org/pypi/PyQt4>`_ (>= 4.4) or
153-
`PySide <https://pypi.python.org/pypi/PySide>`_: for the Qt4Agg backend;
154-
* `PyQt5 <https://pypi.python.org/pypi/PyQt5>`_: for the Qt5Agg backend;
155-
* :term:`wxpython` (>= 2.9 or later): for the WX or WXAgg backend;
156-
* `cairocffi <https://cairocffi.readthedocs.io/en/latest/>`__ (>=
157-
v0.8): for cairo based backends;
158-
* `pycairo <https://pypi.python.org/pypi/pycairo>`_: for GTK3Cairo;
159-
* `Tornado <https://pypi.python.org/pypi/tornado>`_: for the WebAgg backend;
154+
* :term:`tk` (>= 8.3, != 8.6.0 or 8.6.1): for the TkAgg backend;
155+
* `PyQt4 <https://pypi.python.org/pypi/PyQt4>`_ (>= 4.4) or
156+
`PySide <https://pypi.python.org/pypi/PySide>`_: for the Qt4Agg backend;
157+
* `PyQt5 <https://pypi.python.org/pypi/PyQt5>`_: for the Qt5Agg backend;
158+
* :term:`wxpython` (>= 4): for the WX or WXAgg backend;
159+
* `cairocffi <https://cairocffi.readthedocs.io/en/latest/>`_ (>=0.8) or
160+
`pycairo <https://pypi.python.org/pypi/pycairo>`_: for the cairo-based
161+
backends (the latter is required for GTK3Cairo);
162+
* `Tornado <https://pypi.python.org/pypi/tornado>`_: for the WebAgg backend;
160163

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

164-
* `ffmpeg <https://www.ffmpeg.org/>`_/`avconv
165-
<https://libav.org/avconv.html>`_: for saving movies;
166-
* `ImageMagick <https://www.imagemagick.org/script/index.php>`_: for saving
167-
animated gifs;
168-
* `Pillow <https://pillow.readthedocs.io/en/latest/>`_ (>=3.4): for a larger selection of
169-
image file formats: JPEG, BMP, and TIFF image files;
170-
* `LaTeX <https://miktex.org/>`_ and `GhostScript
171-
<https://ghostscript.com/download/>`_ (for rendering text with LaTeX).
167+
* `ffmpeg <https://www.ffmpeg.org/>`_/`avconv
168+
<https://libav.org/avconv.html>`_: for saving movies;
169+
* `ImageMagick <https://www.imagemagick.org/script/index.php>`_: for saving
170+
animated gifs;
171+
* `Pillow <https://pillow.readthedocs.io/en/latest/>`_ (>=3.4): for a larger
172+
selection of image file formats: JPEG, BMP, and TIFF image files;
173+
* `LaTeX <https://miktex.org/>`_ and `GhostScript
174+
<https://ghostscript.com/download/>`_ (for rendering text with LaTeX).
172175

173176
.. note::
174177

175178
Matplotlib depends on non-Python libraries. `pkg-config
176-
<https://www.freedesktop.org/wiki/Software/pkg-config/>`__ can be used
179+
<https://www.freedesktop.org/wiki/Software/pkg-config/>`_ can be used
177180
to find required non-Python libraries and thus make the install go more
178181
smoothly if the libraries and headers are not in the expected locations.
179182

180183
.. note::
181184

182185
The following libraries are shipped with Matplotlib:
183186

184-
- `Agg`: the Anti-Grain Geometry C++ rendering engine;
185-
- `qhull`: to compute Delaunay triangulation;
186-
- `ttconv`: a true type font utility.
187+
- `Agg`: the Anti-Grain Geometry C++ rendering engine;
188+
- `qhull`: to compute Delaunay triangulation;
189+
- `ttconv`: a TrueType font utility.
187190

188191
.. _build_linux:
189192

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.