Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 86be684

Browse files
QuLogicNelleV
authored andcommitted
Tweak phrasing of install instructions.
1 parent 1159085 commit 86be684

File tree

2 files changed

+29
-30
lines changed

2 files changed

+29
-30
lines changed

INSTALL.rst

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ Installing
1414
:ref:`install the latest development version<install_from_source>`.
1515

1616

17-
18-
.. contents..
17+
.. contents..
1918
2019
Installing an official release
2120
==============================
2221

23-
Matplotlib and most of its dependencies arr all available as wheel packages for
22+
Matplotlib and most of its dependencies are all available as wheel packages for
2423
macOS, Windows and Linux distributions::
2524

2625
pip install -U matplotlib
2726

27+
2828
Third-party distributions of Matplotlib
2929
=======================================
3030

@@ -101,9 +101,9 @@ To run the test suite:
101101

102102
GTK3 is not supported on Windows.
103103

104-
For support for other backend, LaTeX rendering, animation input/output and
105-
larger selection of file format, you may need to install `additional
106-
dependencies <_install_requirements>`.
104+
For support for other backends, LaTeX rendering, animation input/output and
105+
a larger selection of file formats, you may need to install `additional
106+
dependencies <_install_requirements>`_.
107107

108108

109109
.. _install_from_source:
@@ -147,7 +147,7 @@ packaging Matplotlib.
147147
If you have installed prerequisites to nonstandard places and need to
148148
inform Matplotlib where they are, edit ``setupext.py`` and add the base
149149
dirs to the ``basedir`` dictionary entry for your ``sys.platform``;
150-
e.g., if the header to some required library is in
150+
e.g., if the header of some required library is in
151151
``/some/path/include/someheader.h``, put ``/some/path`` in the
152152
``basedir`` list for your platform.
153153

@@ -161,7 +161,7 @@ Matplotlib requires a large number of dependencies:
161161
* `Python <https://www.python.org/downloads/>`_ (>= 2.7 or >= 3.4)
162162
* `NumPy <http://www.numpy.org>`_ (>= |minimum_numpy_version|)
163163
* `setuptools <https://setuptools.readthedocs.io/en/latest/>`__
164-
* `dateutil` (>= 1.1)
164+
* dateutil (>= 1.1)
165165
* `pyparsing <https://pyparsing.wikispaces.com/>`__
166166
* `libpng <http://www.libpng.org>`__ (>= 1.2)
167167
* `pytz <http://pytz.sourceforge.net/>`__
@@ -173,39 +173,38 @@ Matplotlib requires a large number of dependencies:
173173
* `subprocess32 <https://pypi.python.org/pypi/subprocess32/>`_ (for Python
174174
2.7 only, on Linux and macOS only)
175175

176-
Optionally, you can also install a number of packages to enables better user
177-
interface toolkit. See :ref:`what-is-a-backend` for more details on the
176+
Optionally, you can also install a number of packages to enable better user
177+
interface toolkits. See :ref:`what-is-a-backend` for more details on the
178178
optional Matplotlib backends and the capabilities they provide.
179179

180180
* :term:`tk` (>= 8.3, != 8.6.0 or 8.6.1): for the TkAgg backend;
181-
* `PyQt4 <https://pypi.python.org/pypi/PyQt4>`_ (>= 4.4): for the Qt4Agg backend;
181+
* `PyQt4 <https://pypi.python.org/pypi/PyQt4>`_ (>= 4.4) or
182+
`PySide <https://pypi.python.org/pypi/PySide>`_: for the Qt4Agg backend;
182183
* `PyQt5 <https://pypi.python.org/pypi/PyQt5>`_: for the Qt5Agg backend;
183184
* :term:`pygtk` (>= 2.4): for the GTK and the GTKAgg backend;
184185
* :term:`wxpython` (>= 2.8 or later): for the WX or WXAgg backend;
185186
* `pycairo <https://pypi.python.org/pypi/pycairo>`_: for GTK3Cairo;
186-
* `PySide <https://pypi.python.org/pypi/PySide>`_: for the Qt4Agg backend;
187187
* `Tornado <https://pypi.python.org/pypi/tornado>`_: for the WebAgg backend.
188188

189189
For better support of animation output format and image file formats, LaTeX,
190-
etc you can
191-
install the following:
190+
etc., you can install the following:
192191

193192
* `ffmpeg <https://www.ffmpeg.org/>`__/`avconv
194193
<https://libav.org/avconv.html>`__ or `mencoder
195194
<https://mplayerhq.hu/design7/news.html>`__ (for saving movies);
196195
* `ImageMagick <https://www.imagemagick.org/script/index.php>`__ (for saving
197196
animated gifs);
198197
* `Pillow <https://python-pillow.org/>`__ (for a larger selection of image
199-
file format: JPEG, BMP, and TIFF image files);
198+
file formats: JPEG, BMP, and TIFF image files);
200199
* `LaTeX <https://miktex.org/>`_ and `GhostScript <https://ghostscript.com/download/>`_
201200
(for rendering text with LaTeX);
202201

203202
.. note::
204203

205204
Matplotlib depends on a large number of non-Python libraries.
206205
`pkg-config <https://www.freedesktop.org/wiki/Software/pkg-config/>`__
207-
can be used to find required non-Python libraries and thus make install go
208-
more smoothly if the libraries and headers are not in the expected
206+
can be used to find required non-Python libraries and thus make the install
207+
go more smoothly if the libraries and headers are not in the expected
209208
locations.
210209

211210
.. note::
@@ -238,7 +237,7 @@ Matplotlib by first installing ``yum-builddep`` and then running::
238237

239238
su -c "yum-builddep python-matplotlib"
240239

241-
This does not build Matplotlib, but it does get and install the
240+
These commands do not build Matplotlib, but instead get and install the
242241
build dependencies, which will make building from source easier.
243242

244243

@@ -249,28 +248,28 @@ Building on macOS
249248

250249
The build situation on macOS is complicated by the various places one
251250
can get the libpng and FreeType requirements (MacPorts, Fink,
252-
/usr/X11R6) and the different architectures (e.g., x86, ppc, universal),
253-
the different macOS version (e.g., 10.4 and 10.5). We recommend that you build
251+
/usr/X11R6), the different architectures (e.g., x86, ppc, universal), and
252+
the different macOS versions (e.g., 10.4 and 10.5). We recommend that you build
254253
the way we do for the macOS release: get the source from the tarball or the
255254
git repository and install the required dependencies through a third-party
256255
package manager. Two widely used package managers are Homebrew, and MacPorts.
257256
The following example illustrates how to install libpng and FreeType using
258-
brew::
257+
``brew``::
259258

260259
brew install libpng freetype pkg-config
261260

262261
If you are using MacPorts, execute the following instead::
263262

264263
port install libpng freetype pkgconfig
265264

266-
To install Matplotlib from source, execute::
265+
After installing the above requirements, install Matplotlib from source by
266+
executing::
267267

268268
python setup.py install
269269

270-
271-
Note that your environment is somewhat important. Some conda users have
272-
found that, to run the tests, their PYTHONPATH must include
273-
/path/to/anaconda/.../site-packages and their DYLD_FALLBACK_LIBRARY_PATH
270+
Note that your environment is somewhat important. Some conda users have
271+
found that, to run the tests, their PYTHONPATH must include
272+
/path/to/anaconda/.../site-packages and their DYLD_FALLBACK_LIBRARY_PATH
274273
must include /path/to/anaconda/lib.
275274

276275

@@ -304,7 +303,7 @@ install.
304303

305304
The commands below assume that you can compile a native Python lib for the Python version of your
306305
choice. See `this howto <https://blog.ionelmc.ro/2014/12/21/compiling-python-extensions-on-windows/>`_
307-
how to install and setup such environments. If in doubt: use Python >= 3.5 as it mostly works
306+
for how to install and setup such environments. If in doubt: use Python >= 3.5 as it mostly works
308307
without fiddling with environment variables::
309308

310309
# create a new environment with the required packages
@@ -332,7 +331,7 @@ without fiddling with environment variables::
332331
python setup.py bdist_wheel
333332

334333
The `build_alllocal.cmd` script in the root folder automates these steps if
335-
you already created and activated the conda environment.
334+
you have already created and activated the conda environment.
336335

337336

338337
Conda packages

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ Matplotlib
2626
Matplotlib is a Python 2D plotting library which produces publication-quality
2727
figures in a variety of hardcopy formats and interactive environments across
2828
platforms. Matplotlib can be used in Python scripts, the Python and IPython
29-
shell (ala MATLAB or Mathematica), web application servers, and various
29+
shell (à la MATLAB or Mathematica), web application servers, and various
3030
graphical user interface toolkits.
3131

3232
`Home page <http://matplotlib.org/>`_
3333

3434
Installation
35-
=============
35+
============
3636

3737
For installation instructions and requirements, see the INSTALL file or the
3838
`install <http://matplotlib.org/users/installing.html>`_ documentation. If you

0 commit comments

Comments
 (0)