Merge branch 'v2.0.0-doc' into v2.0.x

QuLogic · QuLogic · commit 3ce3835e9fc8 · 2017-01-29T21:42:41.000-05:00
diff --git a/doc/contents.rst b/doc/contents.rst
@@ -8,6 +8,8 @@ Overview
     :Release: |version|
     :Date: |today|
 
+    Download `PDF <Matplotlib.pdf>`_
+
 
 .. toctree::
    :maxdepth: 2
diff --git a/doc/devel/testing.rst b/doc/devel/testing.rst
@@ -86,7 +86,7 @@ a colon, e.g., (this is assuming the test is installed)::
 If you want to run the full test suite, but want to save wall time try
 running the tests in parallel::
 
-  python tests.py --nocapture --nose-verbose --processes=5 --process-timeout=300
+  python tests.py --nocapture --verbose --processes=5 --process-timeout=300
 
 
 An alternative implementation that does not look at command line
diff --git a/examples/color/color_cycle_default.py b/examples/color/color_cycle_default.py
@@ -1,10 +1,14 @@
 """
+====================================
+Colors in the default property cycle
+====================================
+
 Display the colors from the default prop_cycle.
 """
-
 import numpy as np
 import matplotlib.pyplot as plt
 
+
 prop_cycle = plt.rcParams['axes.prop_cycle']
 colors = prop_cycle.by_key()['color']
 
diff --git a/examples/color/color_cycle_demo.py b/examples/color/color_cycle_demo.py
@@ -1,30 +1,36 @@
 """
-Demo of custom property-cycle settings to control colors and such
-for multi-line plots.
+===================
+Styling with cycler
+===================
+
+Demo of custom property-cycle settings to control colors and other style
+properties for multi-line plots.
 
 This example demonstrates two different APIs:
 
-    1. Setting the default rc-parameter specifying the property cycle.
+    1. Setting the default rc parameter specifying the property cycle.
        This affects all subsequent axes (but not axes already created).
-    2. Setting the property cycle for a specific axes. This only
-       affects a single axes.
+    2. Setting the property cycle for a single pair of axes.
 """
 from cycler import cycler
 import numpy as np
 import matplotlib.pyplot as plt
 
+
 x = np.linspace(0, 2 * np.pi)
 offsets = np.linspace(0, 2*np.pi, 4, endpoint=False)
 # Create array with shifted-sine curve along each column
 yy = np.transpose([np.sin(x + phi) for phi in offsets])
 
+# 1. Setting prop cycle on default rc parameter
 plt.rc('lines', linewidth=4)
 plt.rc('axes', prop_cycle=(cycler('color', ['r', 'g', 'b', 'y']) +
                            cycler('linestyle', ['-', '--', ':', '-.'])))
 fig, (ax0, ax1) = plt.subplots(nrows=2)
 ax0.plot(yy)
 ax0.set_title('Set default color cycle to rgby')
 
+# 2. Define prop cycle for single set of axes
 ax1.set_prop_cycle(cycler('color', ['c', 'm', 'y', 'k']) +
                    cycler('lw', [1, 2, 3, 4]))
 ax1.plot(yy)
diff --git a/examples/color/colormaps_reference.py b/examples/color/colormaps_reference.py
@@ -1,4 +1,8 @@
 """
+==================
+Colormap reference
+==================
+
 Reference for colormaps included with Matplotlib.
 
 This reference example shows all colormaps included with Matplotlib. Note that
@@ -35,9 +39,9 @@
 import numpy as np
 import matplotlib.pyplot as plt
 
+
 # Have colormaps separated into categories:
 # http://matplotlib.org/examples/color/colormaps_reference.html
-
 cmaps = [('Perceptually Uniform Sequential',
                             ['viridis', 'inferno', 'plasma', 'magma']),
          ('Sequential',     ['Blues', 'BuGn', 'BuPu',
@@ -65,7 +69,7 @@
 gradient = np.vstack((gradient, gradient))
 
 
-def plot_color_gradients(cmap_category, cmap_list):
+def plot_color_gradients(cmap_category, cmap_list, nrows):
     fig, axes = plt.subplots(nrows=nrows)
     fig.subplots_adjust(top=0.95, bottom=0.01, left=0.2, right=0.99)
     axes[0].set_title(cmap_category + ' colormaps', fontsize=14)
@@ -81,7 +85,8 @@ def plot_color_gradients(cmap_category, cmap_list):
     for ax in axes:
         ax.set_axis_off()
 
+
 for cmap_category, cmap_list in cmaps:
-    plot_color_gradients(cmap_category, cmap_list)
+    plot_color_gradients(cmap_category, cmap_list, nrows)
 
 plt.show()
diff --git a/examples/color/named_colors.py b/examples/color/named_colors.py
@@ -1,44 +1,37 @@
 """
-Visualization of named colors.
+========================
+Visualizing named colors
+========================
 
 Simple plot example with the named colors and its visual representation.
 """
+from __future__ import division
 
-from __future__ import (absolute_import, division, print_function,
-                        unicode_literals)
-
-import six
-
-import numpy as np
 import matplotlib.pyplot as plt
 from matplotlib import colors as mcolors
 
 
 colors = dict(mcolors.BASE_COLORS, **mcolors.CSS4_COLORS)
 
-# Sort by hue, saturation, value and name.
+# Sort colors by hue, saturation, value and name.
 by_hsv = sorted((tuple(mcolors.rgb_to_hsv(mcolors.to_rgba(color)[:3])), name)
                 for name, color in colors.items())
-
-# Get the sorted color names.
 sorted_names = [name for hsv, name in by_hsv]
 
 n = len(sorted_names)
 ncols = 4
-nrows = int(np.ceil(1. * n / ncols))
+nrows = n // ncols + 1
 
 fig, ax = plt.subplots(figsize=(8, 5))
 
+# Get height and width
 X, Y = fig.get_dpi() * fig.get_size_inches()
-
-# row height
 h = Y / (nrows + 1)
-# col width
 w = X / ncols
 
 for i, name in enumerate(sorted_names):
     col = i % ncols
-    row = int(i / ncols)
+    row = i // ncols
     y = Y - (row * h) - h
 
     xi_line = w * (col + 0.05)
@@ -49,8 +42,8 @@
             horizontalalignment='left',
             verticalalignment='center')
 
-    ax.hlines(
-        y + h * 0.1, xi_line, xf_line, color=colors[name], linewidth=(h * 0.6))
+    ax.hlines(y + h * 0.1, xi_line, xf_line,
+              color=colors[name], linewidth=(h * 0.6))
 
 ax.set_xlim(0, X)
 ax.set_ylim(0, Y)
diff --git a/examples/misc/multiprocess.py b/examples/misc/multiprocess.py
@@ -79,7 +79,11 @@ def main():
     for ii in range(10):
         pl.plot()
         time.sleep(0.5)
-    raw_input('press Enter...')
+    try:
+        input = raw_input
+    except NameError:
+        pass
+    input('press Enter...')
     pl.plot(finished=True)
 
 if __name__ == '__main__':
diff --git a/examples/pie_and_polar_charts/pie_demo_features.py b/examples/pie_and_polar_charts/pie_demo_features.py
@@ -1,4 +1,8 @@
 """
+===============
+Basic pie chart
+===============
+
 Demo of a basic pie chart plus a few additional features.
 
 In addition to the basic pie chart, this demo shows a few optional features:
diff --git a/examples/pie_and_polar_charts/polar_bar_demo.py b/examples/pie_and_polar_charts/polar_bar_demo.py
@@ -1,10 +1,15 @@
 """
+=======================
+Pie chart on polar axis
+=======================
+
 Demo of bar plot on a polar axis.
 """
 import numpy as np
 import matplotlib.pyplot as plt
 
 
+# Compute pie slices
 N = 20
 theta = np.linspace(0.0, 2 * np.pi, N, endpoint=False)
 radii = 10 * np.random.rand(N)
diff --git a/examples/pie_and_polar_charts/polar_scatter_demo.py b/examples/pie_and_polar_charts/polar_scatter_demo.py
@@ -1,4 +1,8 @@
 """
+==========================
+Scatter plot on polar axis
+==========================
+
 Demo of scatter plot on a polar axis.
 
 Size increases radially in this example and color increases with angle
@@ -8,14 +12,14 @@
 import matplotlib.pyplot as plt
 
 
+# Compute areas and colors
 N = 150
 r = 2 * np.random.rand(N)
 theta = 2 * np.pi * np.random.rand(N)
 area = 200 * r**2
 colors = theta
 
 ax = plt.subplot(111, projection='polar')
-c = ax.scatter(theta, r, c=colors, s=area, cmap=plt.cm.hsv)
-c.set_alpha(0.75)
+c = ax.scatter(theta, r, c=colors, s=area, cmap='hsv', alpha=0.75)
 
 plt.show()
diff --git a/examples/pylab_examples/quiver_demo.py b/examples/pylab_examples/quiver_demo.py
@@ -1,12 +1,12 @@
 '''
-Demonstration of quiver and quiverkey functions. This is using the
-new version coming from the code in quiver.py.
+========================================================
+Demonstration of advanced quiver and quiverkey functions
+========================================================
 
 Known problem: the plot autoscaling does not take into account
 the arrows, so those on the boundaries are often out of the picture.
 This is *not* an easy problem to solve in a perfectly general way.
 The workaround is to manually expand the axes.
-
 '''
 import matplotlib.pyplot as plt
 import numpy as np
@@ -16,81 +16,27 @@
 U = np.cos(X)
 V = np.sin(Y)
 
-# 1
-plt.figure()
-Q = plt.quiver(U, V)
-qk = plt.quiverkey(Q, 0.5, 0.98, 2, r'$2 \frac{m}{s}$', labelpos='W',
-                   fontproperties={'weight': 'bold'})
-l, r, b, t = plt.axis()
-dx, dy = r - l, t - b
-plt.axis([l - 0.05*dx, r + 0.05*dx, b - 0.05*dy, t + 0.05*dy])
-
-plt.title('Minimal arguments, no kwargs')
-
-# 2
 plt.figure()
+plt.title('Arrows scale with plot width, not view')
 Q = plt.quiver(X, Y, U, V, units='width')
-qk = plt.quiverkey(Q, 0.9, 0.95, 2, r'$2 \frac{m}{s}$',
-                   labelpos='E',
-                   coordinates='figure',
-                   fontproperties={'weight': 'bold'})
-plt.axis([-1, 7, -1, 7])
-plt.title('scales with plot width, not view')
+qk = plt.quiverkey(Q, 0.9, 0.9, 2, r'$2 \frac{m}{s}$', labelpos='E',
+                   coordinates='figure')
 
-# 3
 plt.figure()
-Q = plt.quiver(X[::3, ::3], Y[::3, ::3], U[::3, ::3], V[::3, ::3],
-               pivot='mid', color='r', units='inches')
-qk = plt.quiverkey(Q, 0.5, 0.03, 1, r'$1 \frac{m}{s}$',
-                   fontproperties={'weight': 'bold'})
-plt.plot(X[::3, ::3], Y[::3, ::3], 'k.')
-plt.axis([-1, 7, -1, 7])
 plt.title("pivot='mid'; every third arrow; units='inches'")
+Q = plt.quiver(X[::3, ::3], Y[::3, ::3], U[::3, ::3], V[::3, ::3],
+               pivot='mid', units='inches')
+qk = plt.quiverkey(Q, 0.9, 0.9, 1, r'$1 \frac{m}{s}$', labelpos='E',
+                   coordinates='figure')
+plt.scatter(X[::3, ::3], Y[::3, ::3], color='r', s=5)
 
-# 4
 plt.figure()
+plt.title("pivot='tip'; scales with x view")
 M = np.hypot(U, V)
-Q = plt.quiver(X, Y, U, V, M,
-               units='x',
-               pivot='tip',
-               width=0.022,
+Q = plt.quiver(X, Y, U, V, M, units='x', pivot='tip', width=0.022,
                scale=1 / 0.15)
-qk = plt.quiverkey(Q, 0.9, 1.05, 1, r'$1 \frac{m}{s}$',
-                   labelpos='E',
-                   fontproperties={'weight': 'bold'})
-plt.plot(X, Y, 'k.', markersize=2)
-plt.axis([-1, 7, -1, 7])
-plt.title("scales with x view; pivot='tip'")
-
-# 5
-plt.figure()
-Q = plt.quiver(X[::3, ::3], Y[::3, ::3], U[::3, ::3], V[::3, ::3],
-               color='r', units='x',
-               linewidths=(0.5,), edgecolors=('k'), headaxislength=5)
-qk = plt.quiverkey(Q, 0.5, 0.03, 1, r'$1 \frac{m}{s}$',
-                   fontproperties={'weight': 'bold'})
-plt.axis([-1, 7, -1, 7])
-plt.title("triangular head; scale with x view; black edges")
-
-# 6
-plt.figure()
-M = np.zeros(U.shape, dtype='bool')
-XMaskStart = U.shape[0]//3
-YMaskStart = U.shape[1]//3
-XMaskStop = 2*U.shape[0]//3
-YMaskStop = 2*U.shape[1]//3
-
-M[XMaskStart:XMaskStop,
-  YMaskStart:YMaskStop] = True
-U = ma.masked_array(U, mask=M)
-V = ma.masked_array(V, mask=M)
-Q = plt.quiver(U, V)
-qk = plt.quiverkey(Q, 0.5, 0.98, 2, r'$2 \frac{m}{s}$', labelpos='W',
-                   fontproperties={'weight': 'bold'})
-l, r, b, t = plt.axis()
-dx, dy = r - l, t - b
-plt.axis([l - 0.05 * dx, r + 0.05 * dx, b - 0.05 * dy, t + 0.05 * dy])
-plt.title('Minimal arguments, no kwargs - masked values')
-
+qk = plt.quiverkey(Q, 0.9, 0.9, 1, r'$1 \frac{m}{s}$', labelpos='E',
+                   coordinates='figure')
+plt.scatter(X, Y, color='k', s=5)
 
 plt.show()
diff --git a/examples/pylab_examples/quiver_simple_demo.py b/examples/pylab_examples/quiver_simple_demo.py
@@ -0,0 +1,18 @@
+'''
+==================================================
+A simple example of a quiver plot with a quiverkey
+==================================================
+'''
+import matplotlib.pyplot as plt
+import numpy as np
+
+X = np.arange(-10, 10, 1)
+Y = np.arange(-10, 10, 1)
+U, V = np.meshgrid(X, Y)
+
+fig, ax = plt.subplots()
+q = ax.quiver(X, Y, U, V)
+ax.quiverkey(q, X=0.3, Y=1.1, U=10,
+             label='Quiver key, length = 10', labelpos='E')
+
+plt.show()
diff --git a/examples/style_sheets/plot_bmh.py b/examples/style_sheets/plot_bmh.py
diff --git a/examples/style_sheets/plot_dark_background.py b/examples/style_sheets/plot_dark_background.py
diff --git a/examples/style_sheets/plot_fivethirtyeight.py b/examples/style_sheets/plot_fivethirtyeight.py
diff --git a/examples/style_sheets/plot_ggplot.py b/examples/style_sheets/plot_ggplot.py
diff --git a/examples/style_sheets/plot_grayscale.py b/examples/style_sheets/plot_grayscale.py
diff --git a/lib/matplotlib/quiver.py b/lib/matplotlib/quiver.py
