Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

DOC refactored installation instruction #8240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Mar 23, 2017
Merged

DOC refactored installation instruction #8240

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0acf41e
DOC refactored installation instruction
NelleV Mar 8, 2017
b55412e
DOC improved our installation documentation
NelleV Mar 11, 2017
3044d12
DOC Completed the list of optional dependencies
NelleV Mar 11, 2017
60a1b64
MAINT renamed INSTALL into INSTALL.rst for rendering
NelleV Mar 11, 2017
36a917c
DOC fix typos and minor detail in installation.rst
NelleV Mar 16, 2017
f55ed17
Use more https in install docs.
QuLogic Mar 16, 2017
37af9a6
Use consistent capitalization in install instructions.
QuLogic Mar 16, 2017
8ee8a93
Use dnf for Fedora install instructions.
QuLogic Mar 16, 2017
1159085
Rename OSX to macOS for install instructions.
QuLogic Mar 16, 2017
86be684
Tweak phrasing of install instructions.
QuLogic Mar 16, 2017
9265b4a
DOC: Fix broken cross-reference.
QuLogic Mar 17, 2017
bafe158
FIX table of contents on INSTALL.rst
NelleV Mar 19, 2017
dd08c3b
DOC fix README refers to INSTALL.rst
NelleV Mar 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
DOC fix typos and minor detail in installation.rst
  • Loading branch information
@NelleV
NelleV committed Mar 20, 2017
commit 36a917c28b22db3a2ba5ed0a4585c31e0aae538f
55 changes: 22 additions & 33 deletions 55 INSTALL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.. The source of this document is INSTALL. During the doc build process,
.. The source of this document is INSTALL.rst. During the doc build process,
.. this file is copied over to doc/users/installing.rst.
.. Therefore, you must edit INSTALL, *not* doc/users/installing.rst!
.. Therefore, you must edit INSTALL.rst, *not* doc/users/installing.rst!

.. _pip: https://pypi.python.org/pypi/pip/

==========
Expand All @@ -19,16 +20,16 @@ Installing
Installing an official release
==============================

Matplotlib and most of its dependencies all available as wheel packages for
OSX, windows and many linux distributions::
Matplotlib and most of its dependencies arr all available as wheel packages for
OSX, windows and Linux distributions::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we change OSX to macOS?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so, yes.


pip install -U matplotlib
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is true for linux and osx, but it'd be nice to check for windows!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest python -m pip ... consistently as below (also because it helps in presence of venvs if your path is slightly messed up).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not going to change this, as this is non standard and I don't think it is a good idea to promote unconventional way to do steps such as using pip.
Feel free to open a PR once this one is merged.


Third-party distributions of Matplotlib
=======================================

Scientific Python distributions: Conda, Canopy...
--------------------------------------------------
-------------------------------------------------

The first option is to use one of the pre-packaged Python distributions that
already provide Matplotlib built-in. Both `Anaconda
Expand All @@ -43,8 +44,9 @@ Linux : using your package manager
If you are on Linux, you might prefer to use your package manager. Matplotlib
is packaged for almost every major Linux distribution.

* Debian / Ubuntu : ``sudo apt-get install python-matplotlib``
* Fedora / Redhat : ``sudo yum install python-matplotlib``
* Debian / Ubuntu: ``sudo apt-get install python-matplotlib``
* Fedora / Red Hat: ``sudo yum install python-matplotlib``
* Arch: ``sudo pacman -S python-matplotlib``

.. _installing_windows:

Expand All @@ -53,7 +55,7 @@ Windows

We strongly recommend using `scipy-stack compatible Python distributions
<http://www.scipy.org/install.html>`_ such as WinPython, Python(x,y),
Enthought Canopy, or Continuum Anaconda, which have Matplotlib and many of its
Enthought Canopy, or Continuum Anaconda, which have Matplotlib and its
dependencies, plus other useful packages, preinstalled.

For `standard Python <https://www.python.org/downloads/>`_ installations,
Expand All @@ -74,12 +76,6 @@ or
for Python 3.4) redistributable packages need to be installed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about py3.5/3.6?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No clue: this was not written by me, and I don't feel comfortable changing this section. I haven't touched a windows machine in 10years.



The following backends should work out of the box: agg, tkagg, ps,
pdf and svg.
TkAgg is probably the best backend for interactive use from the
standard Python shell or IPython. It is enabled as the default backend
for the official binaries. GTK3 is not supported on Windows.

The Windows wheels (:file:`*.whl`) on the `PyPI download page
<https://pypi.python.org/pypi/matplotlib/>`_ do not contain test data
or example code.
Expand All @@ -94,7 +90,7 @@ To run the test suite:
`mock <https://pypi.python.org/pypi/mock>`_, Pillow, MiKTeX, GhostScript,
ffmpeg, avconv, mencoder, ImageMagick, and `Inkscape
<https://inkscape.org/>`_;
* run ``py.test path\\to\\tests\\directory``.
* run ``py.test path\to\tests\directory``.

.. note::

Expand Down Expand Up @@ -149,7 +145,7 @@ packaging Matplotlib.

If you have installed prerequisites to nonstandard places and need to
inform Matplotlib where they are, edit ``setupext.py`` and add the base
dirs to the ``basedir`` dictionary entry for your ``sys.platform``.
dirs to the ``basedir`` dictionary entry for your ``sys.platform``;
e.g., if the header to some required library is in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

header for / header of?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think header to is correct. I am not the one who wrote this section, so I am going to leave it this one unless an native-english speaker can confirm or correct?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to "header of".

``/some/path/include/someheader.h``, put ``/some/path`` in the
``basedir`` list for your platform.
Expand All @@ -174,7 +170,7 @@ Matplotlib requires a large number of dependencies:
* `backports.functools_lru_cache <https://pypi.python.org/pypi/backports.functools_lru_cache>`_
(for Python 2.7 only)
* `subprocess32 <https://pypi.python.org/pypi/subprocess32/>`_ (for Python
2.7 only, on Linux and mac os X only)
2.7 only, on Linux and Mac OSX only)

Optionally, you can also install a number of packages to enables better user
interface toolkit. See :ref:`what-is-a-backend` for more details on the
Expand All @@ -185,12 +181,11 @@ optional Matplotlib backends and the capabilities they provide.
* `PyQt5 <https://pypi.python.org/pypi/PyQt5>`_: for the Qt5Agg backend;
* :term:`pygtk` (>= 2.4): for the GTK and the GTKAgg backend;
* :term:`wxpython` (>= 2.8 or later): for the WX or WXAgg backend;
* `pycairo <https://pypi.python.org/pypi/pycairo>`_;
* `PySide <https://pypi.python.org/pypi/PySide>`_;
* `PyGTK <https://pypi.python.org/pypi/PyGTK>`_;
* `pycairo <https://pypi.python.org/pypi/pycairo>`_: for gtk3cairo;
* `PySide <https://pypi.python.org/pypi/PySide>`_: for the qt4Agg;
* `Tornado <https://pypi.python.org/pypi/tornado>`_: for the WebAgg backend.

For better support of animation output format and image file format, LaTeX,
For better support of animation output format and image file formats, LaTeX,
etc you can
install the following:

Expand Down Expand Up @@ -249,27 +244,21 @@ Building on OSX

The build situation on OSX is complicated by the various places one
can get the libpng and freetype requirements (darwinports, fink,
/usr/X11R6) and the different architectures (e.g., x86, ppc, universal) and
/usr/X11R6) and the different architectures (e.g., x86, ppc, universal),
the different OSX version (e.g., 10.4 and 10.5). We recommend that you build
the way we do for the OSX release: get the source from the tarball or the
git repository and install the required dependencies through a third-party
package manager: two widely used package managers are homebrew, and MacPorts.
package manager. Two widely used package managers are homebrew, and MacPorts.
The following example illustrates how to install libpng and freetype using
brew:

Example usage::
brew::

brew install libpng freetype pkg-config

If you are using MacPorts, execute the following instead:

Example usage::
If you are using MacPorts, execute the following instead::

port install libpng freetype pkgconfig

To install Matplotlib from source, execute:

Example usage::
To install Matplotlib from source, execute::

python setup.py install

Expand Down Expand Up @@ -310,7 +299,7 @@ install.

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

# create a new environment with the required packages
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.