Skip to content

Commit 9ee8e23

Browse files
committed
Merge branch 'docfix/v1.1.0-polish2'
2 parents 187f403 + 371471a commit 9ee8e23

File tree

8 files changed

+271
-167
lines changed

8 files changed

+271
-167
lines changed

INSTALL

+39-37
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
.. The source of this document is INSTALL. During the doc build process,
2+
.. this file is copied over to doc/users/installing.rst.
3+
.. Therefore, you must edit INSTALL, *not* doc/users/installing.rst!
4+
15
**********
26
Installing
37
**********
48

5-
There are lots of different ways to install matplotlib, and the best
9+
There are many different ways to install matplotlib, and the best
610
way depends on what operating system you are using, what you already
711
have installed, and how you want to use it. To avoid wading through
812
all the details (and potential complications) on this page, the
@@ -15,14 +19,16 @@ Another excellent alternative for Windows users is `Python (x, y)
1519
<http://www.pythonxy.com/foreword.php>`_ which tends to be updated a
1620
bit more frequently. Both of these packages include matplotlib and
1721
pylab, and *lots* of other useful tools. matplotlib is also packaged
18-
for almost every major linux distribution. So if you are on linux,
22+
for almost every major Linux distribution. So if you are on Linux,
1923
your package manager will probably provide matplotlib prebuilt.
2024

21-
One single click installer and you are done.
2225

2326
Manually installing pre-built packages
2427
======================================
2528

29+
General instructions
30+
--------------------
31+
2632
For some people, the prepackaged pythons discussed above are not an
2733
option. That's OK, it's usually pretty easy to get a custom install
2834
working. You will first need to find out if you have python installed
@@ -48,21 +54,21 @@ Next, we need to get matplotlib installed. We provide prebuilt
4854
binaries for OS X and Windows on the matplotlib `download
4955
<http://sourceforge.net/projects/matplotlib/files/>`_ page. Click on
5056
the latest release of the "matplotlib" package, choose your python
51-
version (2.5, 2.6 or 2.7) and your platform (macosx or win32) and you
52-
should be good to go. If you have any problems, please check the
53-
:ref:`installing-faq`, google around a little bit, and post a question
54-
the `mailing list
55-
<http://sourceforge.net/project/showfiles.php?group_id=80706>`_. If
56-
you are on debian/ubuntu linux, it suffices to do::
57+
version (e.g., 2.5, 2.6 or 2.7) and your platform (macosx or win32).
58+
If you have any problems, please check the :ref:`installing-faq`,
59+
search using Google, and/or post a question to the `mailing list
60+
<http://sourceforge.net/project/showfiles.php?group_id=80706>`_.
61+
62+
If you are on Debian/Ubuntu Linux, it suffices to do::
5763

5864
> sudo apt-get install python-matplotlib
5965

6066
Instructions for installing our OSX binaries are found in the FAQ
6167
:ref:`install_osx_binaries`.
6268

6369

64-
Once you have ipython, numpy and matplotlib installed, in ipython's
65-
"pylab" mode you have a MATLAB-like environment that automatically
70+
Once you have ipython, numpy and matplotlib installed, you can use
71+
ipython's "pylab" mode to have a MATLAB-like environment that automatically
6672
handles most of the configuration details for you, so you can get up
6773
and running quickly::
6874

@@ -86,9 +92,9 @@ Installing on Windows
8692
---------------------
8793

8894
If you don't already have python installed, you may want to consider
89-
using the enthought edition of python, which has scipy, numpy, and
90-
wxpython, plus a lot of other goodies, preinstalled - `Enthought
91-
Python <http://www.enthought.com/python>`_. With the enthought
95+
using the Enthought edition of python, which has scipy, numpy, and
96+
wxpython, plus many other useful packages, preinstalled - `Enthought
97+
Python <http://www.enthought.com/python>`_. With the Enthought
9298
edition of python + matplotlib installer, the following backends
9399
should work out of the box: agg, wx, wxagg, tkagg, ps, pdf and svg.
94100

@@ -99,13 +105,14 @@ http://www.dll-files.com/dllindex/dll-files.shtml?msvcp71 or other
99105
sites. You will need to unzip the archive and drag the dll into
100106
:file:`c:\windows\system32`.
101107

102-
All of the GUI backends run on windows, but TkAgg is probably the
108+
All of the GUI backends run on Windows, but TkAgg is probably the
103109
best for interactive use from the standard python shell or ipython.
104-
The windows installer (:file:`*.exe`) on the download page contains all the
110+
The Windows installer (:file:`*.exe`) on the download page contains all the
105111
code you need to get up and running. However, there are many
106-
examples that are not included in the windows installer. If you
107-
want to try the many demos that come in the matplotlib src
108-
distribution, download the zip file and look in the examples subdir.
112+
examples that are not included in the Windows installer. If you
113+
want to try the many demos that come in the matplotlib source
114+
distribution, download the zip file and look in the :file:`examples`
115+
subdirectory.
109116

110117
.. _install_from_source:
111118

@@ -121,17 +128,16 @@ you want to develop matplotlib or just need the latest bugfixed
121128
version, grab the latest git version :ref:`install-from-git`.
122129

123130
Once you have satisfied the requirements detailed below (mainly
124-
python, numpy, libpng and freetype), you build matplotlib in the usual
125-
way::
131+
python, numpy, libpng and freetype), you can build matplotlib::
126132

127133
cd matplotlib
128134
python setup.py build
129135
python setup.py install
130136

131137
We provide a `setup.cfg
132138
<https://github.com/matplotlib/matplotlib/raw/master/setup.cfg.template>`_
133-
file that lives along :file:`setup.py` which you can use to customize
134-
the build process, for example, which default backend to use, whether
139+
file that goes with :file:`setup.py` which you can use to customize
140+
the build process. For example, which default backend to use, whether
135141
some of the optional libraries that matplotlib ships with are
136142
installed, and so on. This file will be particularly useful to those
137143
packaging matplotlib.
@@ -150,10 +156,10 @@ Build requirements
150156

151157
These are external packages which you will need to install before
152158
installing matplotlib. Windows users only need the first two (python
153-
and numpy) since the others are built into the matplotlib windows
159+
and numpy) since the others are built into the matplotlib Windows
154160
installers available for download at the sourceforge site. If you are
155161
building on OSX, see :ref:`build_osx`. If you are installing
156-
dependencies with a package manager, you may need to install the
162+
dependencies with a package manager on Linux, you may need to install the
157163
development packages (look for a "-dev" postfix) in addition to the
158164
libraries themselves.
159165

@@ -183,8 +189,8 @@ libraries themselves.
183189
libpng 1.2 (or later)
184190
library for loading and saving :term:`PNG` files (`download
185191
<http://www.libpng.org/pub/png/libpng.html>`__). libpng requires
186-
zlib. If you are a windows user, you can ignore this since we
187-
build support into the matplotlib single click installer
192+
zlib. If you are a Windows user, you can ignore this because we
193+
build support into the matplotlib single-click installer
188194

189195
:term:`freetype` 1.4 (or later)
190196
library for reading true type font files. If you are a windows
@@ -196,7 +202,7 @@ libpng 1.2 (or later)
196202
These are optional packages which you may want to install to use
197203
matplotlib with a user interface toolkit. See
198204
:ref:`what-is-a-backend` for more details on the optional matplotlib
199-
backends and the capabilities they provide
205+
backends and the capabilities they provide.
200206

201207
:term:`tk` 8.3 or later
202208
The TCL/Tk widgets library used by the TkAgg backend
@@ -243,13 +249,9 @@ Building on OSX
243249
===============
244250

245251
The build situation on OSX is complicated by the various places one
246-
can get the png and freetype requirements from (darwinports, fink,
247-
/usr/X11R6) and the different architectures (x86, ppc, universal) and
248-
the different OSX version (10.4 and 10.5). We recommend that you build
249-
the way we do for the OSX release: by grabbing the tarbar or git
250-
repository, cd-ing into the release/osx dir, and following the
251-
instruction in the README. This directory has a Makefile which will
252-
automatically grab the zlib, png and freetype dependencies from the
253-
web, build them with the right flags to make universal libraries, and
254-
then build the matplotlib source and binary installers.
252+
can get the libpng and freetype requirements (darwinports, fink,
253+
/usr/X11R6) and the different architectures (e.g., x86, ppc, universal) and
254+
the different OSX version (e.g., 10.4 and 10.5). We recommend that you build
255+
the way we do for the OSX release: get the source from the tarball or the
256+
git repository and follow the instruction in :file:`README.osx`.
255257

0 commit comments

Comments
 (0)