From d54ffdb7b02f72cde6a4e3bb6d44436b17bcb53d Mon Sep 17 00:00:00 2001 From: Christoph Gohlke Date: Mon, 30 May 2016 23:48:57 -0700 Subject: [PATCH 1/5] DOC: remove outdated or duplicate Windows documentation Windows installers and eggs are no longer provided. Windows installation instructions are in the INSTALL document. --- doc/faq/installing_faq.rst | 47 +------------------------------------- 1 file changed, 1 insertion(+), 46 deletions(-) diff --git a/doc/faq/installing_faq.rst b/doc/faq/installing_faq.rst index d914f21dee98..fc5ed195d2f6 100644 --- a/doc/faq/installing_faq.rst +++ b/doc/faq/installing_faq.rst @@ -52,31 +52,6 @@ matplotlib was originally installed on your system. Follow the steps below that goes with your original installation method to cleanly remove matplotlib from your system. -Easy Install ------------- - -1. Delete the caches from your :ref:`.matplotlib configuration directory - `. - -2. Run:: - - easy_install -m matplotlib - - -3. Delete any .egg files or directories from your :ref:`installation - directory `. - - - -Windows installer ------------------ - -1. Delete the caches from your :ref:`.matplotlib configuration directory - `. - -2. Use :menuselection:`Start --> Control Panel` to start the :program:`Add and - Remove Software` utility. - Source install -------------- @@ -374,24 +349,4 @@ know: see :ref:`reporting-problems`. Windows Notes ============= -We recommend you use one of the excellent python collections which include -Python itself and a wide range of libraries including matplotlib: - -- Anaconda_ from `Continuum Analytics`_ -- Canopy_ from Enthought_ -- `Python (x, y) `_ - -Python (X, Y) is Windows-only, whereas Anaconda and Canopy are cross-platform. - -.. _windows-installers: - -Standalone binary installers for Windows ----------------------------------------- - -If you have already installed Python and numpy, you can use one of the -matplotlib binary installers for windows -- you can get these from the -`the PyPI matplotlib page `_ -site. Choose the files with an ``.exe`` extension that match your -version of Python (e.g., ``py2.7`` if you installed Python 2.7). If -you haven't already installed Python, you can get the official version -from the `Python web site `_. +See :ref:`installing_windows`. From b1f4d68948e6133d7288769998cc68ca1f2922c9 Mon Sep 17 00:00:00 2001 From: Christoph Gohlke Date: Mon, 30 May 2016 23:55:48 -0700 Subject: [PATCH 2/5] DOC: Update Windows installation instructions Matplotlib and all its required dependencies can be installed using pip. Binaries for Python 3.5 are built with Visual Studio 2015 and include the required C++ runtime files. Remove references to Python 2.6 and 3.3, as well as Windows installers. --- INSTALL | 75 ++++++++++++++++++++++++--------------------------------- 1 file changed, 32 insertions(+), 43 deletions(-) diff --git a/INSTALL b/INSTALL index da0513bf07f6..9c7c898947cf 100644 --- a/INSTALL +++ b/INSTALL @@ -21,14 +21,12 @@ Most platforms : scientific Python distributions The first option is to use one of the pre-packaged python distributions that already provide matplotlib built-in. The Continuum.io Python distribution (`Anaconda -`_ or `miniconda +`_ or `miniconda `_) and the Enthought distribution `(Canopy) `_ are both excellent choices that "just work" out of the box for Windows, OSX and common Linux platforms. Both of these distributions -include matplotlib and *lots* of other useful tools. Another -excellent alternative for Windows users is `Python (x, y) -`_ . +include matplotlib and *lots* of other useful tools. Linux : using your package manager @@ -47,6 +45,7 @@ If you are on Mac OSX you can probably install matplotlib binaries using the standard Python installation program `pip `_. See :ref:`install_osx_binaries`. +.. _installing_windows: Windows ------- @@ -54,33 +53,25 @@ Windows If you don't already have Python installed, we recommend using one of the `scipy-stack compatible Python distributions `_ such as WinPython, Python(x,y), -Enthought Canopy, or Continuum Anaconda, which have matplotlib and -many of its dependencies, plus other useful packages, preinstalled. - -For `standard Python `_ installations -you will also need to install compatible versions of -`setuptools `_, -`numpy `_, -`python-dateutil `_, -`pytz `_, -`pyparsing `_, and -`cycler `_ -in addition to -`matplotlib `_. - -For Python 3.5 the `Visual C++ Redistributable for Visual Studio 2015 -`_ -needs to be installed. -In case Python 2.7 to 3.4 are not installed for all users (not the default), +Enthought Canopy, or Continuum Anaconda, which have matplotlib and many +of its dependencies, plus other useful packages, preinstalled. + +For `standard Python `_ installations, +install matplotlib using `pip `_:: + + python -m pip install -U pip setuptools + python -m pip install matplotlib + +In case Python 2.7 or 3.4 are not installed for all users (not the default), the Microsoft Visual C++ 2008 ( `64 bit `__ or `32 bit `__ -for Python 2.7 to 3.2) or Microsoft Visual C++ 2010 ( +for Python 2.7) or Microsoft Visual C++ 2010 ( `64 bit `__ or `32 bit `__ -for Python 3.3 and 3.4) redistributable packages need to be installed. +for Python 3.4) redistributable packages need to be installed. Matplotlib depends on `Pillow `_ for reading and saving JPEG, BMP, and TIFF image files. @@ -105,18 +96,19 @@ For other backends you may need to install or GhostScript. TkAgg is probably the best backend for interactive use from the -standard Python shell or IPython. It is enabled as the default backend +standard Python shell or IPython. It is enabled as the default backend for the official binaries. GTK3 is not supported on Windows. -The Windows installers (:file:`*.exe`) and wheels (:file:`*.whl`) on -the `PyPI download page `_ do -not contain test data or example code. If you want to try the many -demos that come in the matplotlib source distribution, download the -:file:`*.tar.gz` file and look in the :file:`examples` subdirectory. -To run the test suite, copy the :file:`lib\matplotlib\tests` and -:file:`lib\mpl_toolkits\tests` directories from the source -distribution to :file:`sys.prefix\Lib\site-packages\matplotlib` and -:file:`sys.prefix\Lib\site-packages\mpl_toolkits` respectively, and +The Windows wheels (:file:`*.whl`) on the `PyPI download page +`_ do not contain test data +or example code. +If you want to try the many demos that come in the matplotlib source +distribution, download the :file:`*.tar.gz` file and look in the +:file:`examples` subdirectory. +To run the test suite, copy the :file:`lib\\matplotlib\\tests` and +:file:`lib\\mpl_toolkits\\tests` directories from the source +distribution to :file:`sys.prefix\\Lib\\site-packages\\matplotlib` and +:file:`sys.prefix\\Lib\\site-packages\\mpl_toolkits` respectively, and install `nose `_, `mock `_, Pillow, MiKTeX, GhostScript, ffmpeg, avconv, mencoder, ImageMagick, and `Inkscape @@ -320,17 +312,14 @@ git repository and follow the instruction in :file:`README.osx`. .. _build_windows: - Building on Windows ------------------- The Python shipped from http://www.python.org is compiled with Visual Studio -2008 for versions before 3.3 and Visual Studio 2010 for 3.3 and later. Python -extensions are recommended to be compiled with the same compiler. The .NET -Framework 4.0 is required for MSBuild (you'll likely have the requisite -Framework with Visual Studio). In addition to Visual Studio `CMake -`_ is required for building libpng. - -Since there is no canonical Windows package manager the build methods for -freetype, zlib, libpng, tcl, & tk source code are documented as a build script +2008 for versions before 3.3, Visual Studio 2010 for 3.3 and 3.4, and +Visual Studio 2015 for 3.5. Python extensions are recommended to be compiled +with the same compiler. + +Since there is no canonical Windows package manager, the methods for building +freetype, zlib, and libpng from source code are documented as a build script at `matplotlib-winbuild `_. From 4a0d01a3421d765c195fd30976809e469cc00951 Mon Sep 17 00:00:00 2001 From: Christoph Gohlke Date: Mon, 30 May 2016 23:59:25 -0700 Subject: [PATCH 3/5] DOC: remove some absolute links in frontpage --- doc/_templates/index.html | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/doc/_templates/index.html b/doc/_templates/index.html index c5d133f79470..50234fd8240c 100644 --- a/doc/_templates/index.html +++ b/doc/_templates/index.html @@ -61,7 +61,7 @@

Introduction

You can generate plots, histograms, power spectra, bar charts, errorcharts, scatterplots, etc, with just a few lines of code. For a sampling, see the screenshots, thumbnail gallery, and - examples directory

+ examples directory

For simple plotting the pyplot interface provides a MATLAB-like interface, particularly when combined @@ -98,9 +98,7 @@

John Hunter (1968-2012)

Installation

- Visit the - matplotlib - installation instructions.. + Visit the matplotlib installation instructions.

Documentation

@@ -112,8 +110,8 @@

Documentation

Trying to learn how to do a particular kind of plot? Check out - the gallery, examples, - or the list of plotting + the gallery, examples, + or the list of plotting commands.

Other learning resources

From 43ab6c2e35e80695aabab27d953d0707aee22c3c Mon Sep 17 00:00:00 2001 From: Christoph Gohlke Date: Tue, 31 May 2016 02:09:30 -0700 Subject: [PATCH 4/5] DOC: more updates to Windows installation instructions Update URLs to https. Do not let remain double negative. Fix Sphinx warning. --- INSTALL | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/INSTALL b/INSTALL index 9c7c898947cf..273703b0639d 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,7 @@ .. The source of this document is INSTALL. 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! +.. _pip: https://pypi.python.org/pypi/pip/ ********** Installing @@ -42,7 +43,7 @@ Mac OSX : using pip ------------------- If you are on Mac OSX you can probably install matplotlib binaries using the -standard Python installation program `pip `_. +standard Python installation program pip_. See :ref:`install_osx_binaries`. .. _installing_windows: @@ -56,13 +57,13 @@ one of the `scipy-stack compatible Python distributions Enthought Canopy, or Continuum Anaconda, which have matplotlib and many of its dependencies, plus other useful packages, preinstalled. -For `standard Python `_ installations, -install matplotlib using `pip `_:: +For `standard Python `_ installations, +install matplotlib using pip_:: python -m pip install -U pip setuptools python -m pip install matplotlib -In case Python 2.7 or 3.4 are not installed for all users (not the default), +In case Python 2.7 or 3.4 are not installed for all users, the Microsoft Visual C++ 2008 ( `64 bit `__ or @@ -100,7 +101,7 @@ 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 -`_ do not contain test data +`_ do not contain test data or example code. If you want to try the many demos that come in the matplotlib source distribution, download the :file:`*.tar.gz` file and look in the @@ -112,7 +113,7 @@ distribution to :file:`sys.prefix\\Lib\\site-packages\\matplotlib` and install `nose `_, `mock `_, Pillow, MiKTeX, GhostScript, ffmpeg, avconv, mencoder, ImageMagick, and `Inkscape -`_. +`_. From ff7e408be4c80c940b028b5b38cbe38f628c8c20 Mon Sep 17 00:00:00 2001 From: Christoph Gohlke Date: Tue, 31 May 2016 02:45:14 -0700 Subject: [PATCH 5/5] DOC: fix links to examples --- doc/_templates/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/_templates/index.html b/doc/_templates/index.html index 50234fd8240c..4475d246fbe2 100644 --- a/doc/_templates/index.html +++ b/doc/_templates/index.html @@ -61,7 +61,7 @@

Introduction

You can generate plots, histograms, power spectra, bar charts, errorcharts, scatterplots, etc, with just a few lines of code. For a sampling, see the screenshots, thumbnail gallery, and - examples directory

+ examples directory

For simple plotting the pyplot interface provides a MATLAB-like interface, particularly when combined @@ -110,7 +110,7 @@

Documentation

Trying to learn how to do a particular kind of plot? Check out - the gallery, examples, + the gallery, examples, or the list of plotting commands.