Skip to content

Commit 702399f

Browse files
committed
DOC : edits to optional dependencies
- cleaned up failed merge - added external movie programs to docs (closes matplotlib#2490) - added all the external libraries that are include in the source tree - added six as explicit dependency. This was discussed before and rejected, but I added it here because we now have a minimum version check which should be documented.
1 parent 31d3f6c commit 702399f

File tree

1 file changed

+38
-17
lines changed

1 file changed

+38
-17
lines changed

INSTALL

+38-17
Original file line numberDiff line numberDiff line change
@@ -194,23 +194,9 @@ manager on Linux, you may need to install the development packages
194194
using pip, easy_install or installing from source, the installer
195195
will attempt to download and install `pyparsing` from PyPI.
196196

197-
**Optional dependencies**
198-
199-
`Pillow http://python-imaging.github.io/`__
200-
If Pillow is installed, matplotlib can read and write a larger
201-
selection of image file formats.
202-
203-
204-
libpng 1.2 (or later)
205-
library for loading and saving :term:`PNG` files (`download
206-
<http://www.libpng.org/pub/png/libpng.html>`__). libpng requires
207-
zlib. If you are a Windows user, you can ignore this because we
208-
build support into the matplotlib single-click installer
209-
210-
:term:`freetype` 1.4 (or later)
211-
library for reading true type font files. If you are a windows
212-
user, you can ignore this since we build support into the
213-
matplotlib single click installer.
197+
six 1.3 or later
198+
Python 2/3 compatibility library. This is also a dependency of
199+
:term:`dateutil`.
214200

215201

216202
**Optional GUI frameworks**
@@ -234,6 +220,34 @@ backends and the capabilities they provide.
234220
The python wrappers for the wx widgets library for use with the
235221
WX or WXAgg backend
236222

223+
**Optional external programs**
224+
225+
ffmpeg/avconv or mencoder
226+
Required for the animation module to be save out put to movie
227+
formats.
228+
229+
ImageMagick
230+
Required for the animation module to be able to save to animated gif.
231+
232+
**Optional dependencies**
233+
234+
`Pillow http://python-imaging.github.io/`__
235+
If Pillow is installed, matplotlib can read and write a larger
236+
selection of image file formats.
237+
238+
239+
:term:`freetype` 1.4 (or later)
240+
library for reading true type font files. If you are a windows
241+
user, you can ignore this since we build support into the
242+
matplotlib single click installer.
243+
244+
245+
libpng 1.2 (or later)
246+
library for loading and saving :term:`PNG` files (`download
247+
<http://www.libpng.org/pub/png/libpng.html>`__). libpng requires
248+
zlib. If you are a Windows user, you can ignore this because we
249+
build support into the matplotlib single-click installer
250+
237251
**Required libraries that ship with matplotlib**
238252

239253
:term:`agg` 2.4
@@ -244,6 +258,13 @@ backends and the capabilities they provide.
244258
`PyCXX` 6.2.4
245259
A library for writing Python extensions in C++.
246260

261+
`qhull` 2012.1
262+
A library for computing convex hulls. Used for computing triangulation
263+
and meshes.
264+
265+
`ttconv`
266+
truetype font utility
267+
247268
.. _build_osx:
248269

249270
Building on OSX

0 commit comments

Comments
 (0)