8000 Merge pull request #8961 from tacaswell/doc_install_docs · matplotlib/matplotlib@7981274 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7981274

Browse files
NelleVNelleV
authored
Merge pull request #8961 from tacaswell/doc_install_docs
Doc install docs
2 parents b61c786 + a1a64a1 commit 7981274

File tree

1 file changed

+61
-44
lines changed

1 file changed

+61
-44
lines changed

‎INSTALL.rst

Lines changed: 61 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -19,52 +19,29 @@ Installing
1919
Installing an official release
2020
==============================
2121

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

25-
pip install -U matplotlib
25+
python -m pip install -U pip
26+
python -m pip install -U matplotlib
2627

28+
.. note::
2729

28-
Third-party distributions of Matplotlib
29-
=======================================
30-
31-
Scientific Python distributions: Conda, Canopy...
32-
-------------------------------------------------
33-
34-
The first option is to use one of the pre-packaged Python distributions that
35-
already provide Matplotlib built-in. Both `Anaconda
36-
<https://www.continuum.io/downloads/>`_ and `Canopy
37-
<https://www.enthought.com/products/canopy/>`_ are both excellent choices that
38-
"just work" out of the box for Windows, macOS and common Linux platforms. Both
39-
of these distributions include Matplotlib and *lots* of other useful tools.
30+
The following backends work out of the box: Agg, ps, pdf, svg and TkAgg.
4031

41-
Linux : using your package manager
42-
----------------------------------
32+
For support of other GUI frameworks, LaTeX rendering, saving
33+
animations and a larger selection of file formats, you may need to
34+
install :ref:`additional dependencies <install_requirements>`.
4335

44-
If you are on Linux, you might prefer to use your package manager. Matplotlib
45-
is packaged for almost every major Linux distribution.
46-
47-
* Debian / Ubuntu: ``sudo apt-get install python-matplotlib``
48-
* Fedora: ``sudo dnf install python-matplotlib``
49-
* Red Hat: ``sudo yum install python-matplotlib``
50-
* Arch: ``sudo pacman -S python-matplotlib``
36+
Although not required, we suggest also installing ``IPython`` for
37+
interactive use. To easily install a complete Scientific Python
38+
stack, see :ref:`install_scipy_dists` below.
5139

5240
.. _installing_windows:
5341

5442
Windows
5543
-------
5644

57-
We strongly recommend using `SciPy-stack compatible Python distributions
58-
<https://www.scipy.org/install.html>`_ such as WinPython, Python(x,y),
59-
Enthought Canopy, or Continuum Anaconda, which have Matplotlib and its
60-
dependencies, plus other useful packages, preinstalled.
61-
62-
For `standard Python <https://www.python.org/downloads/>`_ installations,
63-
install Matplotlib using pip_::
64-
65-
python -m pip install -U pip setuptools
66-
python -m pip install matplotlib
67-
6845
In case Python 2.7 or 3.4 are not installed for all users,
6946
the Microsoft Visual C++ 2008
7047
(`64 bit <https://www.microsoft.com/en-us/download/details.aspx?id=15336>`__
@@ -76,8 +53,31 @@ or
7653
`32 bit <https://www.microsoft.com/en-us/download/details.aspx?id=5555>`__
7754
for Python 3.4) redistributable packages need to be installed.
7855

56+
macOS
57+
-----
58+
59+
If you are using Python 2.7 on a Mac you may need to do::
60+
61+
xcode-select --install
62+
63+
so that *subprocess32*, a dependency, may be compiled.
64+
65+
To use the native OSX backend you will need :ref:`a framework build
66+
<osxframework-faq>` build of Python.
67+
7968

80-
The Windows wheels (:file:`*.whl`) on the `PyPI download page
69+
Linux
70+
-----
71+
72+
On extremely old versions of Linux and Python 2.7 you may need to
73+
install the master version of *subprocess32* (`see comments
74+
<https://github.com/google/python-subprocess32/issues/12#issuecomment-304724113>`__).
75+
76+
77+
Test Data
78+
---------
79+
80+
The wheels (:file:`*.whl`) on the `PyPI download page
8181
<https://pypi.python.org/pypi/matplotlib/>`_ do not contain test data
8282
or example code.
8383
If you want to try the many demos that come in the Matplotlib source
@@ -93,17 +93,34 @@ To run the test suite:
9393
<https://inkscape.org/>`_;
9494
* run ``py.test path\to\tests\directory``.
9595

96-
.. note::
9796

98-
The following backends work out of the box: Agg, TkAgg, ps, pdf and svg.
99-
TkAgg is probably the best backend for interactive use from the standard
100-
Python shell or from IPython and is enabled as default.
97+
Third-party distributions of Matplotlib
98+
=======================================
99+
100+
.. _install_scipy_dists:
101+
102+
Scientific Python Distributions
103+
-------------------------------
101104

102-
GTK3 is not supported on Windows.
105+
Both `Anaconda <https://www.continuum.io/downloads/>`_ and `Canopy
106+
<https://www.enthought.com/products/canopy/>`_ are both excellent
107+
choices that "just work" out of the box for Windows, macOS and common
108+
Linux platforms. `WinPython <https://winpython.github.io/>`__ is an
109+
option for windows users. All of these distributions include
110+
Matplotlib and *lots* of other useful tools.
111+
112+
113+
Linux : using your package manager
114+
----------------------------------
115+
116+
If you are on Linux, you might prefer to use your package manager. Matplotlib
117+
is packaged for almost every major Linux distribution.
118+
119+
* Debian / Ubuntu: ``sudo apt-get install python3-matplotlib``
120+
* Fedora: ``sudo dnf install python3-matplotlib``
121+
* Red Hat: ``sudo yum install python3-matplotlib``
122+
* Arch: ``sudo pacman -S python-matplotlib``
103123

104-
For support for other backends, LaTeX rendering, animation input/output and
105-
a larger selection of file formats, you may need to install :ref:`additional
106-
dependencies <install_requirements>`.
107124

108125

109126
.. _install_from_source:

0 commit comments

Comments
 (0)
0