1
- .. The source of this document is INSTALL. During the doc build process,
1
+ .. The source of this document is INSTALL.rst. During the doc build process,
2
2
.. this file is copied over to doc/users/installing.rst.
3
- .. Therefore, you must edit INSTALL, *not* doc/users/installing.rst!
3
+ .. Therefore, you must edit INSTALL.rst, *not* doc/users/installing.rst!
4
+
4
5
.. _pip : https://pypi.python.org/pypi/pip/
5
6
6
7
==========
@@ -19,16 +20,16 @@ Installing
19
20
Installing an official release
20
21
==============================
21
22
22
- Matplotlib and most of its dependencies all available as wheel packages for
23
- OSX, windows and many linux distributions::
23
+ Matplotlib and most of its dependencies arr all available as wheel packages for
24
+ OSX, windows and Linux distributions::
24
25
25
26
pip install -U matplotlib
26
27
27
28
Third-party distributions of Matplotlib
28
29
=======================================
29
30
30
31
Scientific Python distributions: Conda, Canopy...
31
- --------------------------------------------------
32
+ -------------------------------------------------
32
33
33
34
The first option is to use one of the pre-packaged Python distributions that
34
35
already provide Matplotlib built-in. Both `Anaconda
@@ -43,8 +44,9 @@ Linux : using your package manager
43
44
If you are on Linux, you might prefer to use your package manager. Matplotlib
44
45
is packaged for almost every major Linux distribution.
45
46
46
- * Debian / Ubuntu : ``sudo apt-get install python-matplotlib ``
47
- * Fedora / Redhat : ``sudo yum install python-matplotlib ``
47
+ * Debian / Ubuntu: ``sudo apt-get install python-matplotlib ``
48
+ * Fedora / Red Hat: ``sudo yum install python-matplotlib ``
49
+ * Arch: ``sudo pacman -S python-matplotlib ``
48
50
49
51
.. _installing_windows :
50
52
@@ -53,7 +55,7 @@ Windows
53
55
54
56
We strongly recommend using `scipy-stack compatible Python distributions
55
57
<http://www.scipy.org/install.html> `_ such as WinPython, Python(x,y),
56
- Enthought Canopy, or Continuum Anaconda, which have Matplotlib and many of its
58
+ Enthought Canopy, or Continuum Anaconda, which have Matplotlib and its
57
59
dependencies, plus other useful packages, preinstalled.
58
60
59
61
For `standard Python <https://www.python.org/downloads/ >`_ installations,
74
76
for Python 3.4) redistributable packages need to be installed.
75
77
76
78
77
- The following backends should work out of the box: agg, tkagg, ps,
78
- pdf and svg.
79
- TkAgg is probably the best backend for interactive use from the
80
- standard Python shell or IPython. It is enabled as the default backend
81
- for the official binaries. GTK3 is not supported on Windows.
82
-
83
79
The Windows wheels (:file: `*.whl `) on the `PyPI download page
84
80
<https://pypi.python.org/pypi/matplotlib/> `_ do not contain test data
85
81
or example code.
@@ -94,7 +90,7 @@ To run the test suite:
94
90
`mock <https://pypi.python.org/pypi/mock >`_, Pillow, MiKTeX, GhostScript,
95
91
ffmpeg, avconv, mencoder, ImageMagick, and `Inkscape
96
92
<https://inkscape.org/> `_;
97
- * run ``py.test path\\ to\\ tests\ \directory ``.
93
+ * run ``py.test path\to\tests\directory ``.
98
94
99
95
.. note ::
100
96
@@ -149,7 +145,7 @@ packaging Matplotlib.
149
145
150
146
If you have installed prerequisites to nonstandard places and need to
151
147
inform Matplotlib where they are, edit ``setupext.py `` and add the base
152
- dirs to the ``basedir `` dictionary entry for your ``sys.platform ``.
148
+ dirs to the ``basedir `` dictionary entry for your ``sys.platform ``;
153
149
e.g., if the header to some required library is in
154
150
``/some/path/include/someheader.h ``, put ``/some/path `` in the
155
151
``basedir `` list for your platform.
@@ -174,7 +170,7 @@ Matplotlib requires a large number of dependencies:
174
170
* `backports.functools_lru_cache <https://pypi.python.org/pypi/backports.functools_lru_cache >`_
175
171
(for Python 2.7 only)
176
172
* `subprocess32 <https://pypi.python.org/pypi/subprocess32/ >`_ (for Python
177
- 2.7 only, on Linux and mac os X only)
173
+ 2.7 only, on Linux and Mac OSX only)
178
174
179
175
Optionally, you can also install a number of packages to enables better user
180
176
interface toolkit. See :ref: `what-is-a-backend ` for more details on the
@@ -185,12 +181,11 @@ optional Matplotlib backends and the capabilities they provide.
185
181
* `PyQt5 <https://pypi.python.org/pypi/PyQt5 >`_: for the Qt5Agg backend;
186
182
* :term: `pygtk ` (>= 2.4): for the GTK and the GTKAgg backend;
187
183
* :term: `wxpython ` (>= 2.8 or later): for the WX or WXAgg backend;
188
- * `pycairo <https://pypi.python.org/pypi/pycairo >`_;
189
- * `PySide <https://pypi.python.org/pypi/PySide >`_;
190
- * `PyGTK <https://pypi.python.org/pypi/PyGTK >`_;
184
+ * `pycairo <https://pypi.python.org/pypi/pycairo >`_: for gtk3cairo;
185
+ * `PySide <https://pypi.python.org/pypi/PySide >`_: for the qt4Agg;
191
186
* `Tornado <https://pypi.python.org/pypi/tornado >`_: for the WebAgg backend.
192
187
193
- For better support of animation output format and image file format , LaTeX,
188
+ For better support of animation output format and image file formats , LaTeX,
194
189
etc you can
195
190
install the following:
196
191
@@ -249,27 +244,21 @@ Building on OSX
249
244
250
245
The build situation on OSX is complicated by the various places one
251
246
can get the libpng and freetype requirements (darwinports, fink,
252
- /usr/X11R6) and the different architectures (e.g., x86, ppc, universal) and
247
+ /usr/X11R6) and the different architectures (e.g., x86, ppc, universal),
253
248
the different OSX version (e.g., 10.4 and 10.5). We recommend that you build
254
249
the way we do for the OSX release: get the source from the tarball or the
255
250
git repository and install the required dependencies through a third-party
256
- package manager: two widely used package managers are homebrew, and MacPorts.
251
+ package manager. Two widely used package managers are homebrew, and MacPorts.
257
252
The following example illustrates how to install libpng and freetype using
258
- brew:
259
-
260
- Example usage::
253
+ brew::
261
254
262
255
brew install libpng freetype pkg-config
263
256
264
- If you are using MacPorts, execute the following instead:
265
-
266
- Example usage::
257
+ If you are using MacPorts, execute the following instead::
267
258
268
259
port install libpng freetype pkgconfig
269
260
270
- To install Matplotlib from source, execute:
271
-
272
- Example usage::
261
+ To install Matplotlib from source, execute::
273
262
274
263
python setup.py install
275
264
@@ -310,7 +299,7 @@ install.
310
299
311
300
The commands below assume that you can compile a native python lib for the python version of your
312
301
choice. See `this howto <http://blog.ionelmc.ro/2014/12/21/compiling-python-extensions-on-windows/ >`_
313
- how to install and setup such environments. If in doubt: use python 3.5 as it mostly works
302
+ how to install and setup such environments. If in doubt: use Python >= 3.5 as it mostly works
314
303
without fiddling with environment variables::
315
304
316
305
# create a new environment with the required packages
0 commit comments