From bb775aa6407b640b7b7335e4ef005a9974203449 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Sat, 27 Aug 2016 15:01:35 -0400 Subject: [PATCH 01/27] DOC: merge api changes into main api_changes.rst --- doc/api/api_changes.rst | 129 +++++++++++++++++- doc/api/api_changes/2015-03-14-SSH.rst | 16 --- doc/api/api_changes/2015-11-12-DDH.rst | 16 --- doc/api/api_changes/2015-12-01-TAC.rst | 19 --- doc/api/api_changes/2015-12-30_draw_image.rst | 8 -- .../2016-06-deprecate_backends.rst | 20 --- doc/api/api_changes/2016-07-20-EF.rst | 10 -- doc/api/api_changes/qualitative colormaps.rst | 11 -- 8 files changed, 128 insertions(+), 101 deletions(-) delete mode 100644 doc/api/api_changes/2015-03-14-SSH.rst delete mode 100644 doc/api/api_changes/2015-11-12-DDH.rst delete mode 100644 doc/api/api_changes/2015-12-01-TAC.rst delete mode 100644 doc/api/api_changes/2015-12-30_draw_image.rst delete mode 100644 doc/api/api_changes/2016-06-deprecate_backends.rst delete mode 100644 doc/api/api_changes/2016-07-20-EF.rst delete mode 100644 doc/api/api_changes/qualitative colormaps.rst diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst index fa6acba5a2de..71cf48594dcf 100644 --- a/doc/api/api_changes.rst +++ b/doc/api/api_changes.rst @@ -15,13 +15,140 @@ For new features that were added to matplotlib, please see Changes in 2.0.0 ================ + + +Deprecation and removal +----------------------- + Color of Axes -------------- +````````````` The ``axisbg`` and ``axis_bgcolor`` properties on ``Axes`` have been deprecated in favor of ``facecolor``. +GTK and GDK backends deprecated +``````````````````````````````` +The untested and broken GDK and GTK backends have been deprecated. +These backends allows figures to be rendered via the GDK api to +files and GTK2 figures. They are untested, known to be broken and +use have been discouraged for some time. The `GTKAgg` and `GTKCairo` backends +provide better and more tested ways of rendering figures to GTK2 windows. + +WX backend deprecated +````````````````````` +The untested WX backend has been deprecated. +This backend allows figures to be rendered via the WX api to +files and Wx figures. It is untested, and +use have been discouraged for some time. The `WXAgg` backend +provides a better and more tested way of rendering figures to WX windows. + +CocoaAgg backend removed +```````````````````````` + +The deprecated and not fully functional CocoaAgg backend has been removed + + +General +------- + +`Artist.update` has return value +```````````````````````````````` + +The methods `matplotlib.artist.Artist.set`, +`matplotlib.Artist.update`, and the function `matplotlib.artist.setp` +now use a common codepath to look up how to update the given artist +properties (either using the setter methods or an attribute/property). + +The behavior of `matplotlib.Artist.update` is slightly changed to +return a list of the returned values from the setter methods to avoid +changing the API of `matplotlib.Artist.set` and +`matplotlib.artist.setp`. + +The keys passed into `matplotlib.Artist.update` are now converted to +lower case before being processed to match the behavior of +`matplotlib.Artist.set` and `matplotlib.artist.setp`. This should not +break any user code because there are no set methods with capitals in +the names, however going forward this puts a constraint on naming +properties. + + +`Legend` initializers gain edgecolor and facecolor kwargs +`````````````````````````````````````````````````````````` + +The :class:`~matplotlib.legend.Legend` background patch (or 'frame') +can have its `edgecolor` and `facecolor` determined by the +corresponding keyword arguments to its initializer, or to any of the +methods or functions that call that initializer. If left to +their default values of `None`, their values will be taken from +`rcParams`. The previously-existing `framealpha` kwarg still +controls the alpha transparency of the patch. + + +Qualitative colormaps +````````````````````` + +Colorbrewer's qualitative/discrete colormaps ("Accent", "Dark2", "Paired", +"Pastel1", "Pastel2", "Set1", "Set2", "Set3") are now implemented as +``ListedColormap`` instead of ``LinearSegmentedColormap``. + +To use these for images where categories are specified as integers, for +instance, use:: + + plt.imshow(x, cmap='Dark2', norm=colors.NoNorm()) + + +Change in the ``draw_image`` backend API +---------------------------------------- + +The ``draw_image`` method implemented by backends has changed its interface. + +This change is only relevant if the backend declares that it is able +to transform images by returning ``True`` from ``option_scale_image``. +See the ``draw_image`` docstring for more information. + + +Tickers +------- + +``matplotlib.ticker.LinearLocator`` algorithm update +```````````````````````````````````````````````````` + +The ``matplotlib.ticker.LinearLocator`` is used to define the range and location +of tickmarks of a plot when the user wants a exact number of ticks. +``LinearLocator`` thus differs from the default locator ``MaxNLocator``, which +does not necessarily return the exact user requested number of ticks. + +The view range algorithm in ``matplotlib.ticker.LinearLocator`` has been +changed so that more convenient tick location are chosen. The new algorithm +returns a plot view range that is a multiple of the user requested number of +ticks. This ensures tick marks to be located at whole integers more +constistently. For example, when both y-axis of a``twinx`` plot use +``matplotlib.ticker.LinearLocator`` with the same number of ticks, the grids of +both axis will be properly aligned at convenient tick locations. + + +MPlot3D +------- + +New defaults for 3D quiver function in mpl_toolkits.mplot3d.axes3d.py +````````````````````````````````````````````````````````````````````` +Matplotlib has both a 2D and a 3D ``quiver`` function. These changes affect only the 3D function and make the default behavior of the 3D function match 2D version. There are two changes: + +1) The 3D quiver function previously normalized the arrows to be the same length, which makes it unusable for situations where the arrows should be different lengths and does not match the behavior of the 2D function. This normalization behavior is now controlled with the ``normalize`` keyword, which defaults to False. + +2) The ``pivot`` keyword now defaults to ``tail`` instead of ``tip``. This was done in order to match the default behavior of the 2D quiver function. + +To obtain the previous behavior with the 3D quiver function, one can call the function with :: + + ax.quiver(x, y, z, u, v, w, normalize=True, pivot='tip') + +where "ax" is a axes3d object created with something like :: + + import mpl_toolkits.mplot3d.axes3d + ax = plt.sublot(111, projection='3d') + + Changes in 1.5.2 ================ diff --git a/doc/api/api_changes/2015-03-14-SSH.rst b/doc/api/api_changes/2015-03-14-SSH.rst deleted file mode 100644 index 902d0e766f24..000000000000 --- a/doc/api/api_changes/2015-03-14-SSH.rst +++ /dev/null @@ -1,16 +0,0 @@ -``matplotlib.ticker.LinearLocator`` algorithm update -``````````````````````````` - -The ``matplotlib.ticker.LinearLocator`` is used to define the range and location -of tickmarks of a plot when the user wants a exact number of ticks. -``LinearLocator`` thus differs from the default locator ``MaxNLocator``, which -does not necessarily return the exact user requested number of ticks. - -The view range algorithm in ``matplotlib.ticker.LinearLocator`` has been -changed so that more convenient tick location are chosen. The new algorithm -returns a plot view range that is a multiple of the user requested number of -ticks. This ensures tick marks to be located at whole integers more -constistently. For example, when both y-axis of a``twinx`` plot use -``matplotlib.ticker.LinearLocator`` with the same number of ticks, the grids of -both axis will be properly aligned at convenient tick locations. - diff --git a/doc/api/api_changes/2015-11-12-DDH.rst b/doc/api/api_changes/2015-11-12-DDH.rst deleted file mode 100644 index ba899dc6e7f0..000000000000 --- a/doc/api/api_changes/2015-11-12-DDH.rst +++ /dev/null @@ -1,16 +0,0 @@ -New defaults for 3D quiver function in mpl_toolkits.mplot3d.axes3d.py -``````````````````````````` -Matplotlib has both a 2D and a 3D ``quiver`` function. These changes affect only the 3D function and make the default behavior of the 3D function match 2D version. There are two changes: - -1) The 3D quiver function previously normalized the arrows to be the same length, which makes it unusable for situations where the arrows should be different lengths and does not match the behavior of the 2D function. This normalization behavior is now controlled with the ``normalize`` keyword, which defaults to False. - -2) The ``pivot`` keyword now defaults to ``tail`` instead of ``tip``. This was done in order to match the default behavior of the 2D quiver function. - -To obtain the previous behavior with the 3D quiver function, one can call the function with :: - - ax.quiver(x, y, z, u, v, w, normalize=True, pivot='tip') - -where "ax" is a axes3d object created with something like :: - - import mpl_toolkits.mplot3d.axes3d - ax = plt.sublot(111, projection='3d') \ No newline at end of file diff --git a/doc/api/api_changes/2015-12-01-TAC.rst b/doc/api/api_changes/2015-12-01-TAC.rst deleted file mode 100644 index 62ad44cec06e..000000000000 --- a/doc/api/api_changes/2015-12-01-TAC.rst +++ /dev/null @@ -1,19 +0,0 @@ -`Artist.update` has return value -```````````````````````````````` - -The methods `matplotlib.artist.Artist.set`, -`matplotlib.Artist.update`, and the function `matplotlib.artist.setp` -now use a common codepath to look up how to update the given artist -properties (either using the setter methods or an attribute/property). - -The behavior of `matplotlib.Artist.update` is slightly changed to -return a list of the returned values from the setter methods to avoid -changing the API of `matplotlib.Artist.set` and -`matplotlib.artist.setp`. - -The keys passed into `matplotlib.Artist.update` are now converted to -lower case before being processed to match the behavior of -`matplotlib.Artist.set` and `matplotlib.artist.setp`. This should not -break any user code because there are no set methods with capitals in -the names, however going forward this puts a constraint on naming -properties. diff --git a/doc/api/api_changes/2015-12-30_draw_image.rst b/doc/api/api_changes/2015-12-30_draw_image.rst deleted file mode 100644 index fb135bab28bc..000000000000 --- a/doc/api/api_changes/2015-12-30_draw_image.rst +++ /dev/null @@ -1,8 +0,0 @@ -Change in the ``draw_image`` backend API ----------------------------------------- - -The ``draw_image`` method implemented by backends has changed its interface. - -This change is only relevant if the backend declares that it is able -to transform images by returning ``True`` from ``option_scale_image``. -See the ``draw_image`` docstring for more information. diff --git a/doc/api/api_changes/2016-06-deprecate_backends.rst b/doc/api/api_changes/2016-06-deprecate_backends.rst deleted file mode 100644 index 7645f1fad615..000000000000 --- a/doc/api/api_changes/2016-06-deprecate_backends.rst +++ /dev/null @@ -1,20 +0,0 @@ -GTK and GDK backends deprecated -``````````````````````````````` -The untested and broken GDK and GTK backends have been deprecated. -These backends allows figures to be rendered via the GDK api to -files and GTK2 figures. They are untested, known to be broken and -use have been discouraged for some time. The `GTKAgg` and `GTKCairo` backends -provide better and more tested ways of rendering figures to GTK2 windows. - -WX backend deprecated -````````````````````` -The untested WX backend has been deprecated. -This backend allows figures to be rendered via the WX api to -files and Wx figures. It is untested, and -use have been discouraged for some time. The `WXAgg` backend -provides a better and more tested way of rendering figures to WX windows. - -CocoaAgg backend removed -```````````````````````` - -The deprecated and not fully functional CocoaAgg backend has been removed diff --git a/doc/api/api_changes/2016-07-20-EF.rst b/doc/api/api_changes/2016-07-20-EF.rst deleted file mode 100644 index 218458711a46..000000000000 --- a/doc/api/api_changes/2016-07-20-EF.rst +++ /dev/null @@ -1,10 +0,0 @@ -`Legend` initializers gain edgecolor and facecolor kwargs -`````````````````````````````````````````````````````````` - -The :class:`~matplotlib.legend.Legend` background patch (or 'frame') -can have its `edgecolor` and `facecolor` determined by the -corresponding keyword arguments to its initializer, or to any of the -methods or functions that call that initializer. If left to -their default values of `None`, their values will be taken from -`rcParams`. The previously-existing `framealpha` kwarg still -controls the alpha transparency of the patch. diff --git a/doc/api/api_changes/qualitative colormaps.rst b/doc/api/api_changes/qualitative colormaps.rst deleted file mode 100644 index 4cafdbce8bcf..000000000000 --- a/doc/api/api_changes/qualitative colormaps.rst +++ /dev/null @@ -1,11 +0,0 @@ -Qualitative colormaps ---------------------- - -Colorbrewer's qualitative/discrete colormaps ("Accent", "Dark2", "Paired", -"Pastel1", "Pastel2", "Set1", "Set2", "Set3") are now implemented as -``ListedColormap`` instead of ``LinearSegmentedColormap``. - -To use these for images where categories are specified as integers, for -instance, use:: - - plt.imshow(x, cmap='Dark2', norm=colors.NoNorm()) From 7314c900821be42ed67ae79bcafbe4cafe2dc215 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Sat, 27 Aug 2016 15:34:23 -0400 Subject: [PATCH 02/27] DOC: move whats_new files into main whats_new.rst --- doc/users/whats_new.rst | 187 +++++++++++++++++- doc/users/whats_new/2015-11-05_hidpi.rst | 5 - .../2015-12-30_image-interpolation.rst | 18 -- doc/users/whats_new/2016-04_qt_config-AL.rst | 14 -- doc/users/whats_new/faster-text-rendering.rst | 5 - doc/users/whats_new/new_default_font.rst | 14 -- doc/users/whats_new/offset-text-choice.rst | 6 - doc/users/whats_new/offset_label_color.rst | 4 - doc/users/whats_new/qualitative colormaps.rst | 9 - doc/users/whats_new/rcparams.rst | 42 ---- doc/users/whats_new/rgba-support.rst | 11 -- doc/users/whats_new/style_blacklist.rst | 11 -- doc/users/whats_new/ticks_rcparams.rst | 15 -- 13 files changed, 186 insertions(+), 155 deletions(-) delete mode 100644 doc/users/whats_new/2015-11-05_hidpi.rst delete mode 100644 doc/users/whats_new/2015-12-30_image-interpolation.rst delete mode 100644 doc/users/whats_new/2016-04_qt_config-AL.rst delete mode 100644 doc/users/whats_new/faster-text-rendering.rst delete mode 100644 doc/users/whats_new/new_default_font.rst delete mode 100644 doc/users/whats_new/offset-text-choice.rst delete mode 100644 doc/users/whats_new/offset_label_color.rst delete mode 100644 doc/users/whats_new/qualitative colormaps.rst delete mode 100644 doc/users/whats_new/rcparams.rst delete mode 100644 doc/users/whats_new/rgba-support.rst delete mode 100644 doc/users/whats_new/style_blacklist.rst delete mode 100644 doc/users/whats_new/ticks_rcparams.rst diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst index a4bf18733554..657d843c37d1 100644 --- a/doc/users/whats_new.rst +++ b/doc/users/whats_new.rst @@ -8,6 +8,8 @@ For a list of all of the issues and pull requests since the last revision, see the :ref:`github-stats`. .. note:: + matplotlib 2.0 supports Python 2.7, and 3.4+ + matplotlib 1.5 supports Python 2.7, 3.4, and 3.5 matplotlib 1.4 supports Python 2.6, 2.7, 3.3, and 3.4 @@ -23,9 +25,192 @@ revision, see the :ref:`github-stats`. .. contents:: Table of Contents :depth: 3 +New in matplotlib-2.0 +===================== + +New rcParams +------------ + +The parameters ``xtick.top``, ``xtick.bottom``, ``ytick.left`` +and ``ytick.right`` were added to control where the ticks +are drawn. + +Furthermore, the parameters ``xtick.major.top``, ``xtick.major.bottom``, +``xtick.minor.top``, ``xtick.minor.bottom``, ``ytick.major.left``, +``ytick.major.right``, ``ytick.minor.left``, and ``ytick.minor.right`` were +added to control were ticks are drawn. + +``hist.bins`` to control the default number of bins to use in +`~matplotlib.axes.Axes.hist`. This can be an `int`, a list of floats, or +``'auto'`` if numpy >= 1.11 is installed. + + + +Improved color conversion API and RGBA support +---------------------------------------------- + +The :module:`~matplotlib.colors` gained a new color conversion API with +full support for the alpha channel. The main public functions are +:func:`~matplotlib.colors.is_color_like`, :func:`matplotlib.colors.to_rgba`, +:func:`matplotlib.colors.to_rgba_array` and :func:`~matplotlib.colors.to_hex`. +RGBA quadruplets are encoded in hex format as `#rrggbbaa`. + +A side benefit is that the Qt options editor now allows setting the alpha +channel of the artists as well. + + +Configuration (rcParams) +------------------------ + ++---------------------------------+--------------------------------------------------+ +| Parameter | Description | ++=================================+==================================================+ +|`date.autoformatter.year` | foramt string for 'year' scale dates | ++---------------------------------+--------------------------------------------------+ +|`date.autoformatter.month` | format string for 'month' scale dates | ++---------------------------------+--------------------------------------------------+ +|`date.autoformatter.day` | format string for 'day' scale dates | ++---------------------------------+--------------------------------------------------+ +|`date.autoformatter.hour` | format string for 'hour' scale times | ++---------------------------------+--------------------------------------------------+ +|`date.autoformatter.minute` | format string for 'minute' scale times | ++---------------------------------+--------------------------------------------------+ +|`date.autoformatter.second` | format string for 'second' scale times | ++---------------------------------+--------------------------------------------------+ +|`date.autoformatter.microsecond` | format string for 'microsecond' scale times | ++---------------------------------+--------------------------------------------------+ +|`scatter.marker` | default marker for scatter plot | ++---------------------------------+--------------------------------------------------+ +|`svg.hashsalt` | see note | ++---------------------------------+--------------------------------------------------+ + +Added ``svg.hashsalt`` key to rcParams +``````````````````````````````````````` + +If ``svg.hashsalt`` is ``None`` (which it is by default), the svg +backend uses ``uuid4`` to generate the hash salt. If it is not +``None``, it must be a string that is used as the hash salt instead of +``uuid4``. This allows for deterministic SVG output. + + +Removed the ``svg.image_noscale`` rcParam +````````````````````````````````````````` + +As a result of the extensive changes to image handling, the +``svg.image_noscale`` rcParam has been removed. The same +functionality may be achieved by setting ``interpolation='none'`` on +individual images or globally using the ``image.interpolation`` +rcParam. + + +Qualitative colormaps +--------------------- + +ColorBrewer's "qualitative" colormaps ("Accent", "Dark2", "Paired", +"Pastel1", "Pastel2", "Set1", "Set2", "Set3") were intended for discrete +categorical data, with no implication of value, and therefore have been +converted to ``ListedColormap`` instead of ``LinearSegmentedColormap``, so +the colors will no longer be interpolated and they can be used for +choropleths, labeled image features, etc. + + + +Axis offset label now responds to `labelcolor` +---------------------------------------------- + +Axis offset labels are now colored the same as axis tick markers when `labelcolor` is altered. + +Improved offset text choice +--------------------------- +The default offset-text choice was changed to only use significant digits that +are common to all ticks (e.g. 1231..1239 -> 1230, instead of 1231), except when +they straddle a relatively large multiple of a power of ten, in which case that +multiple is chosen (e.g. 1999..2001->2000). + + +Style parameter blacklist +------------------------- + +In order to prevent unexpected consequences from using a style, style +files are no longer able to set parameters that affect things +unrelated to style. These parameters include:: + + 'interactive', 'backend', 'backend.qt4', 'webagg.port', + 'webagg.port_retries', 'webagg.open_in_browser', 'backend_fallback', + 'toolbar', 'timezone', 'datapath', 'figure.max_open_warning', + 'savefig.directory', 'tk.window_focus', 'hardcopy.docstring' + + +Change in default font +---------------------- + +The default font used by matplotlib in text has been changed to DejaVu Sans and +DejaVu Serif for the sans-serif and serif families, respectively. The DejaVu +font family is based on the previous matplotlib default --Bitstream Vera-- but +includes a much wider range of characters. + +The default mathtext font has been changed from Computer Modern to the DejaVu +family to maintain consistency with regular text. Two new options for the +``mathtext.fontset`` configuration parameter have been added: ``dejavusans`` +(default) and ``dejavuserif``. Both of these options use DejaVu glyphs whenever +possible and fall back to STIX symbols when a glyph is not found in DejaVu. To +return to the previous behavior, set the rcParam ``mathtext.fontset`` to ``cm``. + + +Faster text rendering +--------------------- + +Rendering text in the Agg backend is now less fuzzy and about 20% +faster to draw. + + +Improvements for the Qt figure options editor +--------------------------------------------- + +Various usability improvements were implemented for the Qt figure options +editor, among which: +- Line style entries are now sorted without duplicates. +- The colormap and normalization limits can now be set for images. +- Line edits for floating values now display only as many digits as necessary + to avoid precision loss. An important bug was also fixed regarding input + validation using Qt5 and a locale where the decimal separator is ",". +- The axes selector now uses shorter, more user-friendly names for axes, and + does not crash if there are no axes. +- Line and image entries using the default labels ("_lineX", "_imageX") are now + sorted numerically even when there are more than 10 entries. + + +Improved image support +---------------------- + +Prior to version 2.0, matplotlib resampled images by first applying +the color map and then resizing the result. Since the resampling was +performed on the colored image, this introduced colors in the output +image that didn't actually exist in the color map. Now, images are +resampled first (and entirely in floating-point, if the input image is +floating-point), and then the color map is applied. + +In order to make this important change, the image handling code was +almost entirely rewritten. As a side effect, image resampling uses +less memory and fewer datatype conversions than before. + +The experimental private feature where one could "skew" an image by +setting the private member ``_image_skew_coordinate`` has been +removed. Instead, images will obey the transform of the axes on which +they are drawn. + + +Support for HiDPI (Retina) displays in the NbAgg and WebAgg backends +-------------------------------------------------------------------- + +The NbAgg and WebAgg backends will now use the full resolution of your +high-pixel-density display. + + + .. _whats-new-1-5: -new in matplotlib-1.5 +New in matplotlib-1.5 ===================== Interactive OO usage diff --git a/doc/users/whats_new/2015-11-05_hidpi.rst b/doc/users/whats_new/2015-11-05_hidpi.rst deleted file mode 100644 index 6a0ed6ea9fe7..000000000000 --- a/doc/users/whats_new/2015-11-05_hidpi.rst +++ /dev/null @@ -1,5 +0,0 @@ -Support for HiDPI (Retina) displays in the NbAgg and WebAgg backends --------------------------------------------------------------------- - -The NbAgg and WebAgg backends will now use the full resolution of your -high-pixel-density display. diff --git a/doc/users/whats_new/2015-12-30_image-interpolation.rst b/doc/users/whats_new/2015-12-30_image-interpolation.rst deleted file mode 100644 index 897f57e13669..000000000000 --- a/doc/users/whats_new/2015-12-30_image-interpolation.rst +++ /dev/null @@ -1,18 +0,0 @@ -Improved image support ----------------------- - -Prior to version 2.0, matplotlib resampled images by first applying -the color map and then resizing the result. Since the resampling was -performed on the colored image, this introduced colors in the output -image that didn't actually exist in the color map. Now, images are -resampled first (and entirely in floating-point, if the input image is -floating-point), and then the color map is applied. - -In order to make this important change, the image handling code was -almost entirely rewritten. As a side effect, image resampling uses -less memory and fewer datatype conversions than before. - -The experimental private feature where one could "skew" an image by -setting the private member ``_image_skew_coordinate`` has been -removed. Instead, images will obey the transform of the axes on which -they are drawn. diff --git a/doc/users/whats_new/2016-04_qt_config-AL.rst b/doc/users/whats_new/2016-04_qt_config-AL.rst deleted file mode 100644 index 434ec43c7cda..000000000000 --- a/doc/users/whats_new/2016-04_qt_config-AL.rst +++ /dev/null @@ -1,14 +0,0 @@ -Improvements for the Qt figure options editor ---------------------------------------------- - -Various usability improvements were implemented for the Qt figure options -editor, among which: -- Line style entries are now sorted without duplicates. -- The colormap and normalization limits can now be set for images. -- Line edits for floating values now display only as many digits as necessary - to avoid precision loss. An important bug was also fixed regarding input - validation using Qt5 and a locale where the decimal separator is ",". -- The axes selector now uses shorter, more user-friendly names for axes, and - does not crash if there are no axes. -- Line and image entries using the default labels ("_lineX", "_imageX") are now - sorted numerically even when there are more than 10 entries. diff --git a/doc/users/whats_new/faster-text-rendering.rst b/doc/users/whats_new/faster-text-rendering.rst deleted file mode 100644 index d7807bb772f1..000000000000 --- a/doc/users/whats_new/faster-text-rendering.rst +++ /dev/null @@ -1,5 +0,0 @@ -Faster text rendering ---------------------- - -Rendering text in the Agg backend is now less fuzzy and about 20% -faster to draw. diff --git a/doc/users/whats_new/new_default_font.rst b/doc/users/whats_new/new_default_font.rst deleted file mode 100644 index 2c0381c06644..000000000000 --- a/doc/users/whats_new/new_default_font.rst +++ /dev/null @@ -1,14 +0,0 @@ -Change in default font ----------------------- - -The default font used by matplotlib in text has been changed to DejaVu Sans and -DejaVu Serif for the sans-serif and serif families, respectively. The DejaVu -font family is based on the previous matplotlib default --Bitstream Vera-- but -includes a much wider range of characters. - -The default mathtext font has been changed from Computer Modern to the DejaVu -family to maintain consistency with regular text. Two new options for the -``mathtext.fontset`` configuration parameter have been added: ``dejavusans`` -(default) and ``dejavuserif``. Both of these options use DejaVu glyphs whenever -possible and fall back to STIX symbols when a glyph is not found in DejaVu. To -return to the previous behavior, set the rcParam ``mathtext.fontset`` to ``cm``. diff --git a/doc/users/whats_new/offset-text-choice.rst b/doc/users/whats_new/offset-text-choice.rst deleted file mode 100644 index 4ffdc890c5be..000000000000 --- a/doc/users/whats_new/offset-text-choice.rst +++ /dev/null @@ -1,6 +0,0 @@ -Improved offset text choice ---------------------------- -The default offset-text choice was changed to only use significant digits that -are common to all ticks (e.g. 1231..1239 -> 1230, instead of 1231), except when -they straddle a relatively large multiple of a power of ten, in which case that -multiple is chosen (e.g. 1999..2001->2000). diff --git a/doc/users/whats_new/offset_label_color.rst b/doc/users/whats_new/offset_label_color.rst deleted file mode 100644 index b9ff7ddbbda9..000000000000 --- a/doc/users/whats_new/offset_label_color.rst +++ /dev/null @@ -1,4 +0,0 @@ -Axis offset label now responds to `labelcolor` ----------------------------------------------- - -Axis offset labels are now colored the same as axis tick markers when `labelcolor` is altered. \ No newline at end of file diff --git a/doc/users/whats_new/qualitative colormaps.rst b/doc/users/whats_new/qualitative colormaps.rst deleted file mode 100644 index 1906a4fdd2c7..000000000000 --- a/doc/users/whats_new/qualitative colormaps.rst +++ /dev/null @@ -1,9 +0,0 @@ -Qualitative colormaps ---------------------- - -ColorBrewer's "qualitative" colormaps ("Accent", "Dark2", "Paired", -"Pastel1", "Pastel2", "Set1", "Set2", "Set3") were intended for discrete -categorical data, with no implication of value, and therefore have been -converted to ``ListedColormap`` instead of ``LinearSegmentedColormap``, so -the colors will no longer be interpolated and they can be used for -choropleths, labeled image features, etc. diff --git a/doc/users/whats_new/rcparams.rst b/doc/users/whats_new/rcparams.rst deleted file mode 100644 index 5d20097637ac..000000000000 --- a/doc/users/whats_new/rcparams.rst +++ /dev/null @@ -1,42 +0,0 @@ -Configuration (rcParams) ------------------------- - -+---------------------------------+--------------------------------------------------+ -| Parameter | Description | -+=================================+==================================================+ -|`date.autoformatter.year` | foramt string for 'year' scale dates | -+---------------------------------+--------------------------------------------------+ -|`date.autoformatter.month` | format string for 'month' scale dates | -+---------------------------------+--------------------------------------------------+ -|`date.autoformatter.day` | format string for 'day' scale dates | -+---------------------------------+--------------------------------------------------+ -|`date.autoformatter.hour` | format string for 'hour' scale times | -+---------------------------------+--------------------------------------------------+ -|`date.autoformatter.minute` | format string for 'minute' scale times | -+---------------------------------+--------------------------------------------------+ -|`date.autoformatter.second` | format string for 'second' scale times | -+---------------------------------+--------------------------------------------------+ -|`date.autoformatter.microsecond` | format string for 'microsecond' scale times | -+---------------------------------+--------------------------------------------------+ -|`scatter.marker` | default marker for scatter plot | -+---------------------------------+--------------------------------------------------+ -|`svg.hashsalt` | see note | -+---------------------------------+--------------------------------------------------+ - -Added ``svg.hashsalt`` key to rcParams -``````````````````````````````````````` - -If ``svg.hashsalt`` is ``None`` (which it is by default), the svg -backend uses ``uuid4`` to generate the hash salt. If it is not -``None``, it must be a string that is used as the hash salt instead of -``uuid4``. This allows for deterministic SVG output. - - -Removed the ``svg.image_noscale`` rcParam -````````````````````````````````````````` - -As a result of the extensive changes to image handling, the -``svg.image_noscale`` rcParam has been removed. The same -functionality may be achieved by setting ``interpolation='none'`` on -individual images or globally using the ``image.interpolation`` -rcParam. diff --git a/doc/users/whats_new/rgba-support.rst b/doc/users/whats_new/rgba-support.rst deleted file mode 100644 index 9a844e3825ae..000000000000 --- a/doc/users/whats_new/rgba-support.rst +++ /dev/null @@ -1,11 +0,0 @@ -Improved color conversion API and RGBA support ----------------------------------------------- - -The :module:`~matplotlib.colors` gained a new color conversion API with -full support for the alpha channel. The main public functions are -:func:`~matplotlib.colors.is_color_like`, :func:`matplotlib.colors.to_rgba`, -:func:`matplotlib.colors.to_rgba_array` and :func:`~matplotlib.colors.to_hex`. -RGBA quadruplets are encoded in hex format as `#rrggbbaa`. - -A side benefit is that the Qt options editor now allows setting the alpha -channel of the artists as well. diff --git a/doc/users/whats_new/style_blacklist.rst b/doc/users/whats_new/style_blacklist.rst deleted file mode 100644 index 7a7a6146252b..000000000000 --- a/doc/users/whats_new/style_blacklist.rst +++ /dev/null @@ -1,11 +0,0 @@ -Style parameter blacklist -------------------------- - -In order to prevent unexpected consequences from using a style, style -files are no longer able to set parameters that affect things -unrelated to style. These parameters include:: - - 'interactive', 'backend', 'backend.qt4', 'webagg.port', - 'webagg.port_retries', 'webagg.open_in_browser', 'backend_fallback', - 'toolbar', 'timezone', 'datapath', 'figure.max_open_warning', - 'savefig.directory', 'tk.window_focus', 'hardcopy.docstring' diff --git a/doc/users/whats_new/ticks_rcparams.rst b/doc/users/whats_new/ticks_rcparams.rst deleted file mode 100644 index c420787f4e88..000000000000 --- a/doc/users/whats_new/ticks_rcparams.rst +++ /dev/null @@ -1,15 +0,0 @@ -New rcParams ------------- - -The parameters ``xtick.top``, ``xtick.bottom``, ``ytick.left`` -and ``ytick.right`` were added to control where the ticks -are drawn. - -Furthermore, the parameters ``xtick.major.top``, ``xtick.major.bottom``, -``xtick.minor.top``, ``xtick.minor.bottom``, ``ytick.major.left``, -``ytick.major.right``, ``ytick.minor.left``, and ``ytick.minor.right`` were -added to control were ticks are drawn. - -``hist.bins`` to control the default number of bins to use in -`~matplotlib.axes.Axes.hist`. This can be an `int`, a list of floats, or -``'auto'`` if numpy >= 1.11 is installed. From 0d4c84a3d6e66329756b657c3f7b6c12b9fcd7f2 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Sat, 27 Aug 2016 15:50:04 -0400 Subject: [PATCH 03/27] DOC: merge the rcparams sections --- doc/users/whats_new.rst | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst index 657d843c37d1..d75059bf8f87 100644 --- a/doc/users/whats_new.rst +++ b/doc/users/whats_new.rst @@ -28,21 +28,8 @@ revision, see the :ref:`github-stats`. New in matplotlib-2.0 ===================== -New rcParams ------------- - -The parameters ``xtick.top``, ``xtick.bottom``, ``ytick.left`` -and ``ytick.right`` were added to control where the ticks -are drawn. - -Furthermore, the parameters ``xtick.major.top``, ``xtick.major.bottom``, -``xtick.minor.top``, ``xtick.minor.bottom``, ``ytick.major.left``, -``ytick.major.right``, ``ytick.minor.left``, and ``ytick.minor.right`` were -added to control were ticks are drawn. -``hist.bins`` to control the default number of bins to use in -`~matplotlib.axes.Axes.hist`. This can be an `int`, a list of floats, or -``'auto'`` if numpy >= 1.11 is installed. +------------ @@ -59,8 +46,8 @@ A side benefit is that the Qt options editor now allows setting the alpha channel of the artists as well. -Configuration (rcParams) ------------------------- +New Configuration (rcParams) +---------------------------- +---------------------------------+--------------------------------------------------+ | Parameter | Description | @@ -83,6 +70,24 @@ Configuration (rcParams) +---------------------------------+--------------------------------------------------+ |`svg.hashsalt` | see note | +---------------------------------+--------------------------------------------------+ +|`xtick.top`, `xtick.minor.top`, | Control where major and minor ticks are drawn. | +|`xtick.major.top` | The global values are `and` ed with the | +|`xtick.bottom`, | corosponding major/minor values. | +|`xtick.minor.bottom`, | | +|`xtick.major.bottom` | | +|`ytick.left`, `ytick.minor.left`,| | +|`ytick.major.left` | | +|`ytick.right`, | | +|`ytick.minor.right`, | | +|`ytick.major.right` | | ++---------------------------------+--------------------------------------------------+ +|`hist.bins` | the default number of bins to use in | +| | `~matplotlib.axes.Axes.hist`. This can be an | +| | `int`, a list of floats, or ``'auto'`` if numpy | +| | >= 1.11 is installed. | ++---------------------------------+--------------------------------------------------+ + + Added ``svg.hashsalt`` key to rcParams ``````````````````````````````````````` From 4be1c14fc44cd8e8356bb55cdbacb1ae946d426d Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Sat, 27 Aug 2016 16:25:03 -0400 Subject: [PATCH 04/27] DOC: document 'CN' pattern of naming colors --- doc/users/colors.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/users/colors.rst b/doc/users/colors.rst index 4ae509601351..06a44541af29 100644 --- a/doc/users/colors.rst +++ b/doc/users/colors.rst @@ -17,6 +17,8 @@ it can be provided as: `__ These names are prefixed with ``'xkcd:'`` (e.g., ``'xkcd:sky blue'``) to prevent name clashes with the CSS4/X11 names. +* One of ``{'C0', 'C1', 'C2', 'C3', 'C4', 'C5', 'C6', 'C7', 'C8', 'C9'}`` which will use the + color from the Nth element in ``mpl.rcparams['axes.prop_cycle']``. All string specifications of color are case-insensitive. From 7a6429e81f2ff8d702e92f35e5e0299c3bbbcc33 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Sat, 27 Aug 2016 16:54:27 -0400 Subject: [PATCH 05/27] DOC: fix rst --- doc/users/whats_new.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst index d75059bf8f87..3ee730889d9b 100644 --- a/doc/users/whats_new.rst +++ b/doc/users/whats_new.rst @@ -29,14 +29,10 @@ New in matplotlib-2.0 ===================== ------------- - - - Improved color conversion API and RGBA support ---------------------------------------------- -The :module:`~matplotlib.colors` gained a new color conversion API with +The :mod:`~matplotlib.colors` gained a new color conversion API with full support for the alpha channel. The main public functions are :func:`~matplotlib.colors.is_color_like`, :func:`matplotlib.colors.to_rgba`, :func:`matplotlib.colors.to_rgba_array` and :func:`~matplotlib.colors.to_hex`. @@ -49,6 +45,8 @@ channel of the artists as well. New Configuration (rcParams) ---------------------------- +New rcparams added + +---------------------------------+--------------------------------------------------+ | Parameter | Description | +=================================+==================================================+ @@ -174,6 +172,7 @@ Improvements for the Qt figure options editor Various usability improvements were implemented for the Qt figure options editor, among which: + - Line style entries are now sorted without duplicates. - The colormap and normalization limits can now be set for images. - Line edits for floating values now display only as many digits as necessary From 19a96c127ed96f27ac910b2484e3d9604543aaf8 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Sat, 27 Aug 2016 17:31:46 -0400 Subject: [PATCH 06/27] WIP: split up whats_new --- doc/users/prev_whats_new/whats_new_0.98.4.rst | 285 ++ doc/users/prev_whats_new/whats_new_0.99.rst | 60 + doc/users/prev_whats_new/whats_new_1.0.rst | 134 + doc/users/prev_whats_new/whats_new_1.1.rst | 204 ++ doc/users/prev_whats_new/whats_new_1.2.2.rst | 22 + doc/users/prev_whats_new/whats_new_1.2.rst | 200 ++ doc/users/prev_whats_new/whats_new_1.3.rst | 370 +++ doc/users/prev_whats_new/whats_new_1.4.rst | 414 +++ doc/users/prev_whats_new/whats_new_1.5.rst | 722 +++++ doc/users/whats_new.rst | 2389 +---------------- 10 files changed, 2420 insertions(+), 2380 deletions(-) create mode 100644 doc/users/prev_whats_new/whats_new_0.98.4.rst create mode 100644 doc/users/prev_whats_new/whats_new_0.99.rst create mode 100644 doc/users/prev_whats_new/whats_new_1.0.rst create mode 100644 doc/users/prev_whats_new/whats_new_1.1.rst create mode 100644 doc/users/prev_whats_new/whats_new_1.2.2.rst create mode 100644 doc/users/prev_whats_new/whats_new_1.2.rst create mode 100644 doc/users/prev_whats_new/whats_new_1.3.rst create mode 100644 doc/users/prev_whats_new/whats_new_1.4.rst create mode 100644 doc/users/prev_whats_new/whats_new_1.5.rst diff --git a/doc/users/prev_whats_new/whats_new_0.98.4.rst b/doc/users/prev_whats_new/whats_new_0.98.4.rst new file mode 100644 index 000000000000..e5749caa0403 --- /dev/null +++ b/doc/users/prev_whats_new/whats_new_0.98.4.rst @@ -0,0 +1,285 @@ +.. _whats-new-0-98-4: + +New in matplotlib 0.98.4 +======================== + +.. contents:: Table of Contents + :depth: 2 + + + +It's been four months since the last matplotlib release, and there are +a lot of new features and bug-fixes. + +Thanks to Charlie Moad for testing and preparing the source release, +including binaries for OS X and Windows for python 2.4 and 2.5 (2.6 +and 3.0 will not be available until numpy is available on those +releases). Thanks to the many developers who contributed to this +release, with contributions from Jae-Joon Lee, Michael Droettboom, +Ryan May, Eric Firing, Manuel Metz, Jouni K. Seppänen, Jeff Whitaker, +Darren Dale, David Kaplan, Michiel de Hoon and many others who +submitted patches + +.. _legend-refactor: + +Legend enhancements +-------------------- + +Jae-Joon has rewritten the legend class, and added support for +multiple columns and rows, as well as fancy box drawing. See +:func:`~matplotlib.pyplot.legend` and +:class:`matplotlib.legend.Legend`. + +.. plot:: pyplots/whats_new_98_4_legend.py + +.. _fancy-annotations: + +Fancy annotations and arrows +----------------------------- + +Jae-Joon has added lots of support to annotations for drawing fancy +boxes and connectors in annotations. See +:func:`~matplotlib.pyplot.annotate` and +:class:`~matplotlib.patches.BoxStyle`, +:class:`~matplotlib.patches.ArrowStyle`, and +:class:`~matplotlib.patches.ConnectionStyle`. + +.. plot:: pyplots/whats_new_98_4_fancy.py + +.. _psd-amplitude: + + +Native OS X backend +-------------------- + +Michiel de Hoon has provided a native Mac OSX backend that is almost +completely implemented in C. The backend can therefore use Quartz +directly and, depending on the application, can be orders of magnitude +faster than the existing backends. In addition, no third-party +libraries are needed other than Python and NumPy. The backend is +interactive from the usual terminal application on Mac using regular +Python. It hasn't been tested with ipython yet, but in principle it +should to work there as well. Set 'backend : macosx' in your +matplotlibrc file, or run your script with:: + + > python myfile.py -dmacosx + +psd amplitude scaling +------------------------- + +Ryan May did a lot of work to rationalize the amplitude scaling of +:func:`~matplotlib.pyplot.psd` and friends. See +:ref:`pylab_examples-psd_demo2`. and :ref:`pylab_examples-psd_demo3`. +The changes should increase MATLAB +compatibility and increase scaling options. + +.. _fill-between: + +Fill between +------------------ + +Added a :func:`~matplotlib.pyplot.fill_between` function to make it +easier to do shaded region plots in the presence of masked data. You +can pass an *x* array and a *ylower* and *yupper* array to fill +between, and an optional *where* argument which is a logical mask +where you want to do the filling. + +.. plot:: pyplots/whats_new_98_4_fill_between.py + +Lots more +----------- + +Here are the 0.98.4 notes from the CHANGELOG:: + + Added mdehoon's native macosx backend from sf patch 2179017 - JDH + + Removed the prints in the set_*style commands. Return the list of + pretty-printed strings instead - JDH + + Some of the changes Michael made to improve the output of the + property tables in the rest docs broke of made difficult to use + some of the interactive doc helpers, e.g., setp and getp. Having all + the rest markup in the ipython shell also confused the docstrings. + I added a new rc param docstring.harcopy, to format the docstrings + differently for hardcopy and other use. The ArtistInspector + could use a little refactoring now since there is duplication of + effort between the rest out put and the non-rest output - JDH + + Updated spectral methods (psd, csd, etc.) to scale one-sided + densities by a factor of 2 and, optionally, scale all densities by + the sampling frequency. This gives better MATLAB + compatibility. -RM + + Fixed alignment of ticks in colorbars. -MGD + + drop the deprecated "new" keyword of np.histogram() for numpy 1.2 + or later. -JJL + + Fixed a bug in svg backend that new_figure_manager() ignores + keywords arguments such as figsize, etc. -JJL + + Fixed a bug that the handlelength of the new legend class set too + short when numpoints=1 -JJL + + Added support for data with units (e.g., dates) to + Axes.fill_between. -RM + + Added fancybox keyword to legend. Also applied some changes for + better look, including baseline adjustment of the multiline texts + so that it is center aligned. -JJL + + The transmuter classes in the patches.py are reorganized as + subclasses of the Style classes. A few more box and arrow styles + are added. -JJL + + Fixed a bug in the new legend class that didn't allowed a tuple of + coordinate values as loc. -JJL + + Improve checks for external dependencies, using subprocess + (instead of deprecated popen*) and distutils (for version + checking) - DSD + + Reimplementation of the legend which supports baseline alignment, + multi-column, and expand mode. - JJL + + Fixed histogram autoscaling bug when bins or range are given + explicitly (fixes Debian bug 503148) - MM + + Added rcParam axes.unicode_minus which allows plain hyphen for + minus when False - JDH + + Added scatterpoints support in Legend. patch by Erik Tollerud - + JJL + + Fix crash in log ticking. - MGD + + Added static helper method BrokenHBarCollection.span_where and + Axes/pyplot method fill_between. See + examples/pylab/fill_between.py - JDH + + Add x_isdata and y_isdata attributes to Artist instances, and use + them to determine whether either or both coordinates are used when + updating dataLim. This is used to fix autoscaling problems that + had been triggered by axhline, axhspan, axvline, axvspan. - EF + + Update the psd(), csd(), cohere(), and specgram() methods of Axes + and the csd() cohere(), and specgram() functions in mlab to be in + sync with the changes to psd(). In fact, under the hood, these + all call the same core to do computations. - RM + + Add 'pad_to' and 'sides' parameters to mlab.psd() to allow + controlling of zero padding and returning of negative frequency + components, respectively. These are added in a way that does not + change the API. - RM + + Fix handling of c kwarg by scatter; generalize is_string_like to + accept numpy and numpy.ma string array scalars. - RM and EF + + Fix a possible EINTR problem in dviread, which might help when + saving pdf files from the qt backend. - JKS + + Fix bug with zoom to rectangle and twin axes - MGD + + Added Jae Joon's fancy arrow, box and annotation enhancements -- + see examples/pylab_examples/annotation_demo2.py + + Autoscaling is now supported with shared axes - EF + + Fixed exception in dviread that happened with Minion - JKS + + set_xlim, ylim now return a copy of the viewlim array to avoid + modify inplace surprises + + Added image thumbnail generating function + matplotlib.image.thumbnail. See examples/misc/image_thumbnail.py + - JDH + + Applied scatleg patch based on ideas and work by Erik Tollerud and + Jae-Joon Lee. - MM + + Fixed bug in pdf backend: if you pass a file object for output + instead of a filename, e.g., in a wep app, we now flush the object + at the end. - JKS + + Add path simplification support to paths with gaps. - EF + + Fix problem with AFM files that don't specify the font's full name + or family name. - JKS + + Added 'scilimits' kwarg to Axes.ticklabel_format() method, for + easy access to the set_powerlimits method of the major + ScalarFormatter. - EF + + Experimental new kwarg borderpad to replace pad in legend, based + on suggestion by Jae-Joon Lee. - EF + + Allow spy to ignore zero values in sparse arrays, based on patch + by Tony Yu. Also fixed plot to handle empty data arrays, and + fixed handling of markers in figlegend. - EF + + Introduce drawstyles for lines. Transparently split linestyles + like 'steps--' into drawstyle 'steps' and linestyle '--'. Legends + always use drawstyle 'default'. - MM + + Fixed quiver and quiverkey bugs (failure to scale properly when + resizing) and added additional methods for determining the arrow + angles - EF + + Fix polar interpolation to handle negative values of theta - MGD + + Reorganized cbook and mlab methods related to numerical + calculations that have little to do with the goals of those two + modules into a separate module numerical_methods.py Also, added + ability to select points and stop point selection with keyboard in + ginput and manual contour labeling code. Finally, fixed contour + labeling bug. - DMK + + Fix backtick in Postscript output. - MGD + + [ 2089958 ] Path simplification for vector output backends + Leverage the simplification code exposed through path_to_polygons + to simplify certain well-behaved paths in the vector backends + (PDF, PS and SVG). "path.simplify" must be set to True in + matplotlibrc for this to work. - MGD + + Add "filled" kwarg to Path.intersects_path and + Path.intersects_bbox. - MGD + + Changed full arrows slightly to avoid an xpdf rendering problem + reported by Friedrich Hagedorn. - JKS + + Fix conversion of quadratic to cubic Bezier curves in PDF and PS + backends. Patch by Jae-Joon Lee. - JKS + + Added 5-point star marker to plot command q- EF + + Fix hatching in PS backend - MGD + + Fix log with base 2 - MGD + + Added support for bilinear interpolation in + NonUniformImage; patch by Gregory Lielens. - EF + + Added support for multiple histograms with data of + different length - MM + + Fix step plots with log scale - MGD + + Fix masked arrays with markers in non-Agg backends - MGD + + Fix clip_on kwarg so it actually works correctly - MGD + + Fix locale problems in SVG backend - MGD + + fix quiver so masked values are not plotted - JSW + + improve interactive pan/zoom in qt4 backend on windows - DSD + + Fix more bugs in NaN/inf handling. In particular, path + simplification (which does not handle NaNs or infs) will be turned + off automatically when infs or NaNs are present. Also masked + arrays are now converted to arrays with NaNs for consistent + handling of masks and NaNs - MGD and EF + + Added support for arbitrary rasterization resolutions to the SVG + backend. - MW diff --git a/doc/users/prev_whats_new/whats_new_0.99.rst b/doc/users/prev_whats_new/whats_new_0.99.rst new file mode 100644 index 000000000000..b4e787fd9cac --- /dev/null +++ b/doc/users/prev_whats_new/whats_new_0.99.rst @@ -0,0 +1,60 @@ +.. _whats-new-0-99: + +New in matplotlib 0.99 +====================== + +.. contents:: Table of Contents + :depth: 2 + + + +New documentation +----------------- + +Jae-Joon Lee has written two new guides :ref:`plotting-guide-legend` +and :ref:`plotting-guide-annotation`. Michael Sarahan has written +:ref:`image_tutorial`. John Hunter has written two new tutorials on +working with paths and transformations: :ref:`path_tutorial` and +:ref:`transforms_tutorial`. + +.. _whats-new-mplot3d: + +mplot3d +-------- + + +Reinier Heeres has ported John Porter's mplot3d over to the new +matplotlib transformations framework, and it is now available as a +toolkit mpl_toolkits.mplot3d (which now comes standard with all mpl +installs). See :ref:`mplot3d-examples-index` and +:ref:`toolkit_mplot3d-tutorial` + +.. plot:: pyplots/whats_new_99_mplot3d.py + +.. _whats-new-axes-grid: + +axes grid toolkit +----------------- + +Jae-Joon Lee has added a new toolkit to ease displaying multiple images in +matplotlib, as well as some support for curvilinear grids to support +the world coordinate system. The toolkit is included standard with all +new mpl installs. See :ref:`axes_grid-examples-index` and +:ref:`axes_grid_users-guide-index`. + +.. plot:: pyplots/whats_new_99_axes_grid.py + +.. _whats-new-spine: + +Axis spine placement +-------------------- + +Andrew Straw has added the ability to place "axis spines" -- the lines +that denote the data limits -- in various arbitrary locations. No +longer are your axis lines constrained to be a simple rectangle around +the figure -- you can turn on or off left, bottom, right and top, as +well as "detach" the spine to offset it away from the data. See +:ref:`pylab_examples-spine_placement_demo` and +:class:`matplotlib.spines.Spine`. + +.. plot:: pyplots/whats_new_99_spines.py diff --git a/doc/users/prev_whats_new/whats_new_1.0.rst b/doc/users/prev_whats_new/whats_new_1.0.rst new file mode 100644 index 000000000000..5af33dd4fcbe --- /dev/null +++ b/doc/users/prev_whats_new/whats_new_1.0.rst @@ -0,0 +1,134 @@ +.. _whats-new-1-0: + +New in matplotlib 1.0 +====================== + +.. contents:: Table of Contents + :depth: 2 + +.. _whats-new-html5: + +HTML5/Canvas backend +--------------------- + +Simon Ratcliffe and Ludwig Schwardt have released an `HTML5/Canvas +`__ backend for matplotlib. The +backend is almost feature complete, and they have done a lot of work +comparing their html5 rendered images with our core renderer Agg. The +backend features client/server interactive navigation of matplotlib +figures in an html5 compliant browser. + +Sophisticated subplot grid layout +--------------------------------- + +Jae-Joon Lee has written :mod:`~matplotlib.gridspec`, a new module for +doing complex subplot layouts, featuring row and column spans and +more. See :ref:`gridspec-guide` for a tutorial overview. + +.. plot:: users/plotting/examples/demo_gridspec01.py + +Easy pythonic subplots +----------------------- + +Fernando Perez got tired of all the boilerplate code needed to create a +figure and multiple subplots when using the matplotlib API, and wrote +a :func:`~matplotlib.pyplot.subplots` helper function. Basic usage +allows you to create the figure and an array of subplots with numpy +indexing (starts with 0). e.g.:: + + fig, axarr = plt.subplots(2, 2) + axarr[0,0].plot([1,2,3]) # upper, left + +See :ref:`pylab_examples-subplots_demo` for several code examples. + +Contour fixes and and triplot +--------------------------------- + +Ian Thomas has fixed a long-standing bug that has vexed our most +talented developers for years. :func:`~matplotlib.pyplot.contourf` +now handles interior masked regions, and the boundaries of line and +filled contours coincide. + +Additionally, he has contributed a new module :mod:`~matplotlib.tri` and +helper function :func:`~matplotlib.pyplot.triplot` for creating and +plotting unstructured triangular grids. + +.. plot:: mpl_examples/pylab_examples/triplot_demo.py + +multiple calls to show supported +--------------------------------- + +A long standing request is to support multiple calls to +:func:`~matplotlib.pyplot.show`. This has been difficult because it +is hard to get consistent behavior across operating systems, user +interface toolkits and versions. Eric Firing has done a lot of work +on rationalizing show across backends, with the desired behavior to +make show raise all newly created figures and block execution until +they are closed. Repeated calls to show should raise newly created +figures since the last call. Eric has done a lot of testing on the +user interface toolkits and versions and platforms he has access to, +but it is not possible to test them all, so please report problems to +the `mailing list +`__ +and `bug tracker +`__. + + +mplot3d graphs can be embedded in arbitrary axes +------------------------------------------------- + +You can now place an mplot3d graph into an arbitrary axes location, +supporting mixing of 2D and 3D graphs in the same figure, and/or +multiple 3D graphs in a single figure, using the "projection" keyword +argument to add_axes or add_subplot. Thanks Ben Root. + +.. plot:: pyplots/whats_new_1_subplot3d.py + +tick_params +------------ + +Eric Firing wrote tick_params, a convenience method for changing the +appearance of ticks and tick labels. See pyplot function +:func:`~matplotlib.pyplot.tick_params` and associated Axes method +:meth:`~matplotlib.axes.Axes.tick_params`. + +Lots of performance and feature enhancements +--------------------------------------------- + + +* Faster magnification of large images, and the ability to zoom in to + a single pixel + +* Local installs of documentation work better + +* Improved "widgets" -- mouse grabbing is supported + +* More accurate snapping of lines to pixel boundaries + +* More consistent handling of color, particularly the alpha channel, + throughout the API + +Much improved software carpentry +--------------------------------- + +The matplotlib trunk is probably in as good a shape as it has ever +been, thanks to improved `software carpentry +`__. We now have a `buildbot +`__ which runs a suite of `nose +`__ regression tests on every +svn commit, auto-generating a set of images and comparing them against +a set of known-goods, sending emails to developers on failures with a +pixel-by-pixel image comparison. Releases and release +bugfixes happen in branches, allowing active new feature development +to happen in the trunk while keeping the release branches stable. +Thanks to Andrew Straw, Michael Droettboom and other matplotlib +developers for the heavy lifting. + +Bugfix marathon +---------------- + +Eric Firing went on a bug fixing and closing marathon, closing over +100 bugs on the `bug tracker +`__ with +help from Jae-Joon Lee, Michael Droettboom, Christoph Gohlke and +Michiel de Hoon. diff --git a/doc/users/prev_whats_new/whats_new_1.1.rst b/doc/users/prev_whats_new/whats_new_1.1.rst new file mode 100644 index 000000000000..7a622bb3eb9c --- /dev/null +++ b/doc/users/prev_whats_new/whats_new_1.1.rst @@ -0,0 +1,204 @@ +.. _whats-new-1-1: + +New in matplotlib 1.1 +===================== + +.. contents:: Table of Contents + :depth: 2 + + +Sankey Diagrams +--------------- + +Kevin Davies has extended Yannick Copin's original Sankey example into a module +(:mod:`~matplotlib.sankey`) and provided new examples +(:ref:`api-sankey_demo_basics`, :ref:`api-sankey_demo_links`, +:ref:`api-sankey_demo_rankine`). + +.. plot:: mpl_examples/api/sankey_demo_rankine.py + +Animation +--------- + +Ryan May has written a backend-independent framework for creating +animated figures. The :mod:`~matplotlib.animation` module is intended +to replace the backend-specific examples formerly in the +:ref:`examples-index` listings. Examples using the new framework are +in :ref:`animation-examples-index`; see the entrancing :ref:`double +pendulum ` which uses +:meth:`matplotlib.animation.Animation.save` to create the movie below. + +.. raw:: html + + + +This should be considered as a beta release of the framework; +please try it and provide feedback. + + +Tight Layout +------------ + +A frequent issue raised by users of matplotlib is the lack of a layout +engine to nicely space out elements of the plots. While matplotlib still +adheres to the philosophy of giving users complete control over the placement +of plot elements, Jae-Joon Lee created the :mod:`~matplotlib.tight_layout` +module and introduced a new +command :func:`~matplotlib.pyplot.tight_layout` +to address the most common layout issues. + +.. plot:: + + plt.rcParams['savefig.facecolor'] = "0.8" + plt.rcParams['figure.figsize'] = 4, 3 + + fig, axes_list = plt.subplots(2, 1) + for ax in axes_list.flat: + ax.set(xlabel="x-label", ylabel="y-label", title="before tight_layout") + ax.locator_params(nbins=3) + + plt.show() + + plt.rcParams['savefig.facecolor'] = "0.8" + plt.rcParams['figure.figsize'] = 4, 3 + + fig, axes_list = plt.subplots(2, 1) + for ax in axes_list.flat: + ax.set(xlabel="x-label", ylabel="y-label", title="after tight_layout") + ax.locator_params(nbins=3) + + plt.tight_layout() + plt.show() + +The usage of this functionality can be as simple as :: + + plt.tight_layout() + +and it will adjust the spacing between subplots +so that the axis labels do not overlap with neighboring subplots. A +:ref:`plotting-guide-tight-layout` has been created to show how to use +this new tool. + +PyQT4, PySide, and IPython +-------------------------- + +Gerald Storer made the Qt4 backend compatible with PySide as +well as PyQT4. At present, however, PySide does not support +the PyOS_InputHook mechanism for handling gui events while +waiting for text input, so it cannot be used with the new +version 0.11 of `IPython `__. Until this +feature appears in PySide, IPython users should use +the PyQT4 wrapper for QT4, which remains the matplotlib default. + +An rcParam entry, "backend.qt4", has been added to allow users +to select PyQt4, PyQt4v2, or PySide. The latter two use the +Version 2 Qt API. In most cases, users can ignore this rcParam +variable; it is available to aid in testing, and to provide control +for users who are embedding matplotlib in a PyQt4 or PySide app. + + +Legend +------ + +Jae-Joon Lee has improved plot legends. First, +legends for complex plots such as :meth:`~matplotlib.pyplot.stem` plots +will now display correctly. Second, the 'best' placement of a legend has +been improved in the presence of NANs. + +See the :ref:`plotting-guide-legend` for more detailed explanation and +examples. + +.. plot:: mpl_examples/pylab_examples/legend_demo4.py + +mplot3d +------- + +In continuing the efforts to make 3D plotting in matplotlib just as easy +as 2D plotting, Ben Root has made several improvements to the +:mod:`~mpl_toolkits.mplot3d` module. + +* :class:`~mpl_toolkits.mplot3d.axes3d.Axes3D` has been + improved to bring the class towards feature-parity with regular + Axes objects + +* Documentation for :ref:`toolkit_mplot3d-index` was significantly expanded + +* Axis labels and orientation improved + +* Most 3D plotting functions now support empty inputs + +* Ticker offset display added: + +.. plot:: mpl_examples/mplot3d/offset_demo.py + +* :meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.contourf` + gains *zdir* and *offset* kwargs. You can now do this: + +.. plot:: mpl_examples/mplot3d/contourf3d_demo2.py + +Numerix support removed +----------------------- + +After more than two years of deprecation warnings, Numerix support has +now been completely removed from matplotlib. + +Markers +------- + +The list of available markers for :meth:`~matplotlib.pyplot.plot` and +:meth:`~matplotlib.pyplot.scatter` has now been merged. While they +were mostly similar, some markers existed for one function, but not +the other. This merge did result in a conflict for the 'd' diamond +marker. Now, 'd' will be interpreted to always mean "thin" diamond +while 'D' will mean "regular" diamond. + +Thanks to Michael Droettboom for this effort. + +Other improvements +------------------ + +* Unit support for polar axes and :func:`~matplotlib.axes.Axes.arrow` + +* :class:`~matplotlib.projections.polar.PolarAxes` gains getters and setters for + "theta_direction", and "theta_offset" to allow for theta to go in + either the clock-wise or counter-clockwise direction and to specify where zero + degrees should be placed. + :meth:`~matplotlib.projections.polar.PolarAxes.set_theta_zero_location` is an + added convenience function. + +* Fixed error in argument handling for tri-functions such as + :meth:`~matplotlib.pyplot.tripcolor` + +* ``axes.labelweight`` parameter added to rcParams. + +* For :meth:`~matplotlib.pyplot.imshow`, *interpolation='nearest'* will + now always perform an interpolation. A "none" option has been added to + indicate no interpolation at all. + +* An error in the Hammer projection has been fixed. + +* *clabel* for :meth:`~matplotlib.pyplot.contour` now accepts a callable. + Thanks to Daniel Hyams for the original patch. + +* Jae-Joon Lee added the :class:`~mpl_toolkits.axes_grid1.axes_divider.HBox` + and :class:`~mpl_toolkits.axes_grid1.axes_divider.VBox` classes. + +* Christoph Gohlke reduced memory usage in :meth:`~matplotlib.pyplot.imshow`. + +* :meth:`~matplotlib.pyplot.scatter` now accepts empty inputs. + +* The behavior for 'symlog' scale has been fixed, but this may result + in some minor changes to existing plots. This work was refined by + ssyr. + +* Peter Butterworth added named figure support to + :func:`~matplotlib.pyplot.figure`. + +* Michiel de Hoon has modified the MacOSX backend to make + its interactive behavior consistent with the other backends. + +* Pim Schellart added a new colormap called "cubehelix". + Sameer Grover also added a colormap called "coolwarm". See it and all + other colormaps :ref:`here `. + +* Many bug fixes and documentation improvements. diff --git a/doc/users/prev_whats_new/whats_new_1.2.2.rst b/doc/users/prev_whats_new/whats_new_1.2.2.rst new file mode 100644 index 000000000000..51c43403d22c --- /dev/null +++ b/doc/users/prev_whats_new/whats_new_1.2.2.rst @@ -0,0 +1,22 @@ +.. _whats-new-1-2-2: + +New in matplotlib 1.2.2 +======================= + +.. contents:: Table of Contents + :depth: 2 + + + +Improved collections +-------------------- + +The individual items of a collection may now have different alpha +values and be rendered correctly. This also fixes a bug where +collections were always filled in the PDF backend. + +Multiple images on same axes are correctly transparent +------------------------------------------------------ + +When putting multiple images onto the same axes, the background color +of the axes will now show through correctly. diff --git a/doc/users/prev_whats_new/whats_new_1.2.rst b/doc/users/prev_whats_new/whats_new_1.2.rst new file mode 100644 index 000000000000..c35f1b14ada0 --- /dev/null +++ b/doc/users/prev_whats_new/whats_new_1.2.rst @@ -0,0 +1,200 @@ +.. _whats-new-1-2: + + +New in matplotlib 1.2 +===================== + +.. contents:: Table of Contents + :depth: 2 + + +Python 3.x support +------------------ + +Matplotlib 1.2 is the first version to support Python 3.x, +specifically Python 3.1 and 3.2. To make this happen in a reasonable +way, we also had to drop support for Python versions earlier than 2.6. + +This work was done by Michael Droettboom, the Cape Town Python Users' +Group, many others and supported financially in part by the SAGE +project. + +The following GUI backends work under Python 3.x: Gtk3Cairo, Qt4Agg, +TkAgg and MacOSX. The other GUI backends do not yet have adequate +bindings for Python 3.x, but continue to work on Python 2.6 and 2.7, +particularly the Qt and QtAgg backends (which have been +deprecated). The non-GUI backends, such as PDF, PS and SVG, work on +both Python 2.x and 3.x. + +Features that depend on the Python Imaging Library, such as JPEG +handling, do not work, since the version of PIL for Python 3.x is not +sufficiently mature. + +PGF/TikZ backend +---------------- +Peter Würtz wrote a backend that allows matplotlib to export figures as +drawing commands for LaTeX. These can be processed by PdfLaTeX, XeLaTeX or +LuaLaTeX using the PGF/TikZ package. Usage examples and documentation are +found in :ref:`pgf-tutorial`. + +.. image:: /_static/pgf_preamble.* + +Locator interface +----------------- + +Philip Elson exposed the intelligence behind the tick Locator classes with a +simple interface. For instance, to get no more than 5 sensible steps which +span the values 10 and 19.5:: + + >>> import matplotlib.ticker as mticker + >>> locator = mticker.MaxNLocator(nbins=5) + >>> print(locator.tick_values(10, 19.5)) + [ 10. 12. 14. 16. 18. 20.] + +Tri-Surface Plots +----------------- + +Damon McDougall added a new plotting method for the +:mod:`~mpl_toolkits.mplot3d` toolkit called +:meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf`. + +.. plot:: mpl_examples/mplot3d/trisurf3d_demo.py + +Control the lengths of colorbar extensions +------------------------------------------ + +Andrew Dawson added a new keyword argument *extendfrac* to +:meth:`~matplotlib.pyplot.colorbar` to control the length of +minimum and maximum colorbar extensions. + +.. plot:: + + import matplotlib.pyplot as plt + import numpy as np + + x = y = np.linspace(0., 2*np.pi, 100) + X, Y = np.meshgrid(x, y) + Z = np.cos(X) * np.sin(0.5*Y) + + clevs = [-.75, -.5, -.25, 0., .25, .5, .75] + cmap = plt.cm.get_cmap(name='jet', lut=8) + + ax1 = plt.subplot(211) + cs1 = plt.contourf(x, y, Z, clevs, cmap=cmap, extend='both') + cb1 = plt.colorbar(orientation='horizontal', extendfrac=None) + cb1.set_label('Default length colorbar extensions') + + ax2 = plt.subplot(212) + cs2 = plt.contourf(x, y, Z, clevs, cmap=cmap, extend='both') + cb2 = plt.colorbar(orientation='horizontal', extendfrac='auto') + cb2.set_label('Custom length colorbar extensions') + + plt.show() + + +Figures are picklable +--------------------- + +Philip Elson added an experimental feature to make figures picklable +for quick and easy short-term storage of plots. Pickle files +are not designed for long term storage, are unsupported when restoring a pickle +saved in another matplotlib version and are insecure when restoring a pickle +from an untrusted source. Having said this, they are useful for short term +storage for later modification inside matplotlib. + + +Set default bounding box in matplotlibrc +------------------------------------------ + +Two new defaults are available in the matplotlibrc configuration file: +``savefig.bbox``, which can be set to 'standard' or 'tight', and +``savefig.pad_inches``, which controls the bounding box padding. + + +New Boxplot Functionality +------------------------- + +Users can now incorporate their own methods for computing the median and its +confidence intervals into the :meth:`~matplotlib.axes.boxplot` method. For +every column of data passed to boxplot, the user can specify an accompanying +median and confidence interval. + +.. plot:: mpl_examples/pylab_examples/boxplot_demo3.py + + +New RC parameter functionality +------------------------------ + +Matthew Emmett added a function and a context manager to help manage RC +parameters: :func:`~matplotlib.rc_file` and :class:`~matplotlib.rc_context`. +To load RC parameters from a file:: + + >>> mpl.rc_file('mpl.rc') + +To temporarily use RC parameters:: + + >>> with mpl.rc_context(fname='mpl.rc', rc={'text.usetex': True}): + >>> ... + + +Streamplot +---------- + +Tom Flannaghan and Tony Yu have added a new +:meth:`~matplotlib.pyplot.streamplot` function to plot the streamlines of +a vector field. This has been a long-requested feature and complements the +existing :meth:`~matplotlib.pyplot.quiver` function for plotting vector fields. +In addition to simply plotting the streamlines of the vector field, +:meth:`~matplotlib.pyplot.streamplot` allows users to map the colors and/or +line widths of the streamlines to a separate parameter, such as the speed or +local intensity of the vector field. + +.. plot:: mpl_examples/images_contours_and_fields/streamplot_demo_features.py + + +New hist functionality +---------------------- + +Nic Eggert added a new `stacked` kwarg to :meth:`~matplotlib.pyplot.hist` that +allows creation of stacked histograms using any of the histogram types. +Previously, this functionality was only available by using the `barstacked` +histogram type. Now, when `stacked=True` is passed to the function, any of the +histogram types can be stacked. The `barstacked` histogram type retains its +previous functionality for backwards compatibility. + +Updated shipped dependencies +---------------------------- + +The following dependencies that ship with matplotlib and are +optionally installed alongside it have been updated: + + - `pytz ` 2012d + + - `dateutil ` 1.5 on Python 2.x, + and 2.1 on Python 3.x + + +Face-centred colors in tripcolor plots +-------------------------------------- + +Ian Thomas extended :meth:`~matplotlib.pyplot.tripcolor` to allow one color +value to be specified for each triangular face rather than for each point in +a triangulation. + +.. plot:: mpl_examples/pylab_examples/tripcolor_demo.py + +Hatching patterns in filled contour plots, with legends +------------------------------------------------------- + +Phil Elson added support for hatching to +:func:`~matplotlib.pyplot.contourf`, together with the ability +to use a legend to identify contoured ranges. + +.. plot:: mpl_examples/pylab_examples/contourf_hatching.py + +Known issues in the matplotlib 1.2 release +------------------------------------------ + +- When using the Qt4Agg backend with IPython 0.11 or later, the save + dialog will not display. This should be fixed in a future version + of IPython. diff --git a/doc/users/prev_whats_new/whats_new_1.3.rst b/doc/users/prev_whats_new/whats_new_1.3.rst new file mode 100644 index 000000000000..e566df1bac4e --- /dev/null +++ b/doc/users/prev_whats_new/whats_new_1.3.rst @@ -0,0 +1,370 @@ +.. _whats-new-1-3: + +New in matplotlib 1.3 +===================== + +.. contents:: Table of Contents + :depth: 2 + + + +New in 1.3.1 +------------ + +1.3.1 is a bugfix release, primarily dealing with improved setup and +handling of dependencies, and correcting and enhancing the +documentation. + +The following changes were made in 1.3.1 since 1.3.0. + +Enhancements +```````````` + +- Added a context manager for creating multi-page pdfs (see + `matplotlib.backends.backend_pdf.PdfPages`). + +- The WebAgg backend should now have lower latency over heterogeneous + Internet connections. + +Bug fixes +````````` + +- Histogram plots now contain the endline. + +- Fixes to the Molleweide projection. + +- Handling recent fonts from Microsoft and Macintosh-style fonts with + non-ascii metadata is improved. + +- Hatching of fill between plots now works correctly in the PDF + backend. + +- Tight bounding box support now works in the PGF backend. + +- Transparent figures now display correctly in the Qt4Agg backend. + +- Drawing lines from one subplot to another now works. + +- Unit handling on masked arrays has been improved. + +Setup and dependencies +`````````````````````` + +- Now works with any version of pyparsing 1.5.6 or later, without displaying + hundreds of warnings. + +- Now works with 64-bit versions of Ghostscript on MS-Windows. + +- When installing from source into an environment without Numpy, Numpy + will first be downloaded and built and then used to build + matplotlib. + +- Externally installed backends are now always imported using a + fully-qualified path to the module. + +- Works with newer version of wxPython. + +- Can now build with a PyCXX installed globally on the system from source. + +- Better detection of Gtk3 dependencies. + +Testing +``````` + +- Tests should now work in non-English locales. + +- PEP8 conformance tests now report on locations of issues. + + +New plotting features +--------------------- + +`xkcd`-style sketch plotting +```````````````````````````` +To give your plots a sense of authority that they may be missing, +Michael Droettboom (inspired by the work of many others in +:ghpull:`1329`) has added an `xkcd-style `__ sketch +plotting mode. To use it, simply call :func:`matplotlib.pyplot.xkcd` +before creating your plot. For really fine control, it is also possible +to modify each artist's sketch parameters individually with +:meth:`matplotlib.artist.Artist.set_sketch_params`. + +.. plot:: mpl_examples/showcase/xkcd.py + +Updated Axes3D.contour methods +------------------------------ +Damon McDougall updated the +:meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.tricontour` and +:meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.tricontourf` methods to allow 3D +contour plots on abitrary unstructured user-specified triangulations. + +.. plot:: mpl_examples/mplot3d/tricontour3d_demo.py + +New eventplot plot type +``````````````````````` +Todd Jennings added a :func:`~matplotlib.pyplot.eventplot` function to +create multiple rows or columns of identical line segments + +.. plot:: mpl_examples/pylab_examples/eventplot_demo.py + +As part of this feature, there is a new +:class:`~matplotlib.collections.EventCollection` class that allows for +plotting and manipulating rows or columns of identical line segments. + +Triangular grid interpolation +````````````````````````````` +Geoffroy Billotey and Ian Thomas added classes to perform +interpolation within triangular grids: +(:class:`~matplotlib.tri.LinearTriInterpolator` and +:class:`~matplotlib.tri.CubicTriInterpolator`) and a utility class to +find the triangles in which points lie +(:class:`~matplotlib.tri.TrapezoidMapTriFinder`). A helper class to +perform mesh refinement and smooth contouring was also added +(:class:`~matplotlib.tri.UniformTriRefiner`). Finally, a class +implementing some basic tools for triangular mesh improvement was +added (:class:`~matplotlib.tri.TriAnalyzer`). + +.. plot:: mpl_examples/pylab_examples/tricontour_smooth_user.py + +Baselines for stackplot +``````````````````````` +Till Stensitzki added non-zero baselines to +:func:`~matplotlib.pyplot.stackplot`. They may be symmetric or +weighted. + +.. plot:: mpl_examples/pylab_examples/stackplot_demo2.py + +Rectangular colorbar extensions +``````````````````````````````` +Andrew Dawson added a new keyword argument *extendrect* to +:meth:`~matplotlib.pyplot.colorbar` to optionally make colorbar +extensions rectangular instead of triangular. + +More robust boxplots +```````````````````` +Paul Hobson provided a fix to the :func:`~matplotlib.pyplot.boxplot` +method that prevent whiskers from being drawn inside the box for +oddly distributed data sets. + +Calling subplot() without arguments +``````````````````````````````````` +A call to :func:`~matplotlib.pyplot.subplot` without any arguments now +acts the same as `subplot(111)` or `subplot(1,1,1)` -- it creates one +axes for the whole figure. This was already the behavior for both +:func:`~matplotlib.pyplot.axes` and +:func:`~matplotlib.pyplot.subplots`, and now this consistency is +shared with :func:`~matplotlib.pyplot.subplot`. + +Drawing +------- + +Independent alpha values for face and edge colors +````````````````````````````````````````````````` +Wes Campaigne modified how :class:`~matplotlib.patches.Patch` objects are +drawn such that (for backends supporting transparency) you can set different +alpha values for faces and edges, by specifying their colors in RGBA format. +Note that if you set the alpha attribute for the patch object (e.g. using +:meth:`~matplotlib.patches.Patch.set_alpha` or the ``alpha`` keyword +argument), that value will override the alpha components set in both the +face and edge colors. + +Path effects on lines +````````````````````` +Thanks to Jae-Joon Lee, path effects now also work on plot lines. + +.. plot:: mpl_examples/pylab_examples/patheffect_demo.py + +Easier creation of colormap and normalizer for levels with colors +````````````````````````````````````````````````````````````````` +Phil Elson added the :func:`matplotlib.colors.from_levels_and_colors` +function to easily create a colormap and normalizer for representation +of discrete colors for plot types such as +:func:`matplotlib.pyplot.pcolormesh`, with a similar interface to that +of :func:`contourf`. + +Full control of the background color +```````````````````````````````````` +Wes Campaigne and Phil Elson fixed the Agg backend such that PNGs are +now saved with the correct background color when +:meth:`fig.patch.get_alpha` is not 1. + +Improved ``bbox_inches="tight"`` functionality +`````````````````````````````````````````````` +Passing ``bbox_inches="tight"`` through to :func:`plt.save` now takes +into account *all* artists on a figure - this was previously not the +case and led to several corner cases which did not function as +expected. + +Initialize a rotated rectangle +`````````````````````````````` +Damon McDougall extended the :class:`~matplotlib.patches.Rectangle` +constructor to accept an `angle` kwarg, specifying the rotation of a +rectangle in degrees. + +Text +---- + +Anchored text support +````````````````````` +The `svg` and `pgf` backends are now able to save text alignment +information to their output formats. This allows to edit text elements +in saved figures, using Inkscape for example, while preserving their +intended position. For `svg` please note that you'll have to disable +the default text-to-path conversion (``mpl.rc('svg', +fonttype='none')``). + +Better vertical text alignment and multi-line text +`````````````````````````````````````````````````` +The vertical alignment of text is now consistent across backends. You +may see small differences in text placement, particularly with rotated +text. + +If you are using a custom backend, note that the `draw_text` renderer +method is now passed the location of the baseline, not the location of +the bottom of the text bounding box. + +Multi-line text will now leave enough room for the height of very tall +or very low text, such as superscripts and subscripts. + +Left and right side axes titles +``````````````````````````````` +Andrew Dawson added the ability to add axes titles flush with the left +and right sides of the top of the axes using a new keyword argument +`loc` to :func:`~matplotlib.pyplot.title`. + +Improved manual contour plot label positioning +`````````````````````````````````````````````` +Brian Mattern modified the manual contour plot label positioning code +to interpolate along line segments and find the actual closest point +on a contour to the requested position. Previously, the closest path +vertex was used, which, in the case of straight contours was sometimes +quite distant from the requested location. Much more precise label +positioning is now possible. + +Configuration (rcParams) +------------------------ + +Quickly find rcParams +````````````````````` +Phil Elson made it easier to search for rcParameters by passing a +valid regular expression to :func:`matplotlib.RcParams.find_all`. +:class:`matplotlib.RcParams` now also has a pretty repr and str +representation so that search results are printed prettily: + + >>> import matplotlib + >>> print(matplotlib.rcParams.find_all('\.size')) + RcParams({'font.size': 12, + 'xtick.major.size': 4, + 'xtick.minor.size': 2, + 'ytick.major.size': 4, + 'ytick.minor.size': 2}) + +``axes.xmargin`` and ``axes.ymargin`` added to rcParams +``````````````````````````````````````````````````````` +``rcParam`` values (``axes.xmargin`` and ``axes.ymargin``) were added +to configure the default margins used. Previously they were +hard-coded to default to 0, default value of both rcParam values is 0. + +Changes to font rcParams +```````````````````````` +The `font.*` rcParams now affect only text objects created after the +rcParam has been set, and will not retroactively affect already +existing text objects. This brings their behavior in line with most +other rcParams. + +``savefig.jpeg_quality`` added to rcParams +`````````````````````````````````````````` +rcParam value ``savefig.jpeg_quality`` was added so that the user can +configure the default quality used when a figure is written as a JPEG. +The default quality is 95; previously, the default quality was 75. +This change minimizes the artifacting inherent in JPEG images, +particularly with images that have sharp changes in color as plots +often do. + +Backends +-------- + +WebAgg backend +`````````````` +Michael Droettboom, Phil Elson and others have developed a new +backend, WebAgg, to display figures in a web browser. It works with +animations as well as being fully interactive. + +.. image:: /_static/webagg_screenshot.png + +Future versions of matplotlib will integrate this backend with the +IPython notebook for a fully web browser based plotting frontend. + +Remember save directory +``````````````````````` +Martin Spacek made the save figure dialog remember the last directory +saved to. The default is configurable with the new `savefig.directory` +rcParam in `matplotlibrc`. + +Documentation and examples +-------------------------- + +Numpydoc docstrings +``````````````````` +Nelle Varoquaux has started an ongoing project to convert matplotlib's +docstrings to numpydoc format. See `MEP10 +`__ for more +information. + +Example reorganization +`````````````````````` +Tony Yu has begun work reorganizing the examples into more meaningful +categories. The new gallery page is the fruit of this ongoing work. +See `MEP12 `__ for +more information. + +Examples now use subplots() +``````````````````````````` +For the sake of brevity and clarity, most of the :ref:`examples +` now use the newer +:func:`~matplotlib.pyplot.subplots`, which creates a figure and one +(or multiple) axes object(s) in one call. The old way involved a call +to :func:`~matplotlib.pyplot.figure`, followed by one (or multiple) +:func:`~matplotlib.pyplot.subplot` calls. + +Infrastructure +-------------- + +Housecleaning +````````````` +A number of features that were deprecated in 1.2 or earlier, or have +not been in a working state for a long time have been removed. +Highlights include removing the Qt version 3 backends, and the FltkAgg +and Emf backends. See :ref:`changes_in_1_3` for a complete list. + +New setup script +```````````````` +matplotlib 1.3 includes an entirely rewritten setup script. We now +ship fewer dependencies with the tarballs and installers themselves. +Notably, `pytz`, `dateutil`, `pyparsing` and `six` are no longer +included with matplotlib. You can either install them manually first, +or let `pip` install them as dependencies along with matplotlib. It +is now possible to not include certain subcomponents, such as the unit +test data, in the install. See `setup.cfg.template` for more +information. + +XDG base directory support +`````````````````````````` +On Linux, matplotlib now uses the `XDG base directory specification +` +to find the `matplotlibrc` configuration file. `matplotlibrc` should +now be kept in `~/.config/matplotlib`, rather than `~/.matplotlib`. +If your configuration is found in the old location, it will still be +used, but a warning will be displayed. + +Catch opening too many figures using pyplot +``````````````````````````````````````````` +Figures created through `pyplot.figure` are retained until they are +explicitly closed. It is therefore common for new users of matplotlib +to run out of memory when creating a large series of figures in a loop +without closing them. + +matplotlib will now display a `RuntimeWarning` when too many figures +have been opened at once. By default, this is displayed for 20 or +more figures, but the exact number may be controlled using the +``figure.max_open_warning`` rcParam. diff --git a/doc/users/prev_whats_new/whats_new_1.4.rst b/doc/users/prev_whats_new/whats_new_1.4.rst new file mode 100644 index 000000000000..90e025aabd0b --- /dev/null +++ b/doc/users/prev_whats_new/whats_new_1.4.rst @@ -0,0 +1,414 @@ +.. _whats-new-1-4: + + +New in matplotlib 1.4 +===================== + +Thomas A. Caswell served as the release manager for the 1.4 release. + + +.. contents:: Table of Contents + :depth: 2 + + +New colormap +------------ +In heatmaps, a green-to-red spectrum is often used to indicate intensity of +activity, but this can be problematic for the red/green colorblind. A new, +colorblind-friendly colormap is now available at :class:`matplotlib.cm.Wistia`. +This colormap maintains the red/green symbolism while achieving deuteranopic +legibility through brightness variations. See +`here `__ +for more information. + +The nbagg backend +----------------- +Phil Elson added a new backend, named "nbagg", which enables interactive +figures in a live IPython notebook session. The backend makes use of the +infrastructure developed for the webagg backend, which itself gives +standalone server backed interactive figures in the browser, however nbagg +does not require a dedicated matplotlib server as all communications are +handled through the IPython Comm machinery. + +As with other backends nbagg can be enabled inside the IPython notebook with:: + + import matplotlib + matplotlib.use('nbagg') + +Once figures are created and then subsequently shown, they will placed in an +interactive widget inside the notebook allowing panning and zooming in the +same way as any other matplotlib backend. Because figures require a connection +to the IPython notebook server for their interactivity, once the notebook is +saved, each figure will be rendered as a static image - thus allowing +non-interactive viewing of figures on services such as +`nbviewer `__. + + + +New plotting features +--------------------- + +Power-law normalization +``````````````````````` +Ben Gamari added a power-law normalization method, +:class:`~matplotlib.colors.PowerNorm`. This class maps a range of +values to the interval [0,1] with power-law scaling with the exponent +provided by the constructor's `gamma` argument. Power law normalization +can be useful for, e.g., emphasizing small populations in a histogram. + +Fully customizable boxplots +``````````````````````````` +Paul Hobson overhauled the :func:`~matplotlib.pyplot.boxplot` method such +that it is now completely customizable in terms of the styles and positions +of the individual artists. Under the hood, :func:`~matplotlib.pyplot.boxplot` +relies on a new function (:func:`~matplotlib.cbook.boxplot_stats`), which +accepts any data structure currently compatible with +:func:`~matplotlib.pyplot.boxplot`, and returns a list of dictionaries +containing the positions for each element of the boxplots. Then +a second method, :func:`~matplotlib.Axes.bxp` is called to draw the boxplots +based on the stats. + +The :func:`~matplotlib.pyplot.boxplot` function can be used as before to +generate boxplots from data in one step. But now the user has the +flexibility to generate the statistics independently, or to modify the +output of :func:`~matplotlib.cbook.boxplot_stats` prior to plotting +with :func:`~matplotlib.Axes.bxp`. + +Lastly, each artist (e.g., the box, outliers, cap, notches) can now be +toggled on or off and their styles can be passed in through individual +kwargs. See the examples: +:ref:`statistics-boxplot_demo` and +:ref:`statistics-bxp_demo` + +Added a bool kwarg, :code:`manage_xticks`, which if False disables the management +of the ticks and limits on the x-axis by :func:`~matplotlib.axes.Axes.bxp`. + +Support for datetime axes in 2d plots +````````````````````````````````````` +Andrew Dawson added support for datetime axes to +:func:`~matplotlib.pyplot.contour`, :func:`~matplotlib.pyplot.contourf`, +:func:`~matplotlib.pyplot.pcolormesh` and :func:`~matplotlib.pyplot.pcolor`. + +Support for additional spectrum types +````````````````````````````````````` +Todd Jennings added support for new types of frequency spectrum plots: +:func:`~matplotlib.pyplot.magnitude_spectrum`, +:func:`~matplotlib.pyplot.phase_spectrum`, and +:func:`~matplotlib.pyplot.angle_spectrum`, as well as corresponding functions +in mlab. + +He also added these spectrum types to :func:`~matplotlib.pyplot.specgram`, +as well as adding support for linear scaling there (in addition to the +existing dB scaling). Support for additional spectrum types was also added to +:func:`~matplotlib.mlab.specgram`. + +He also increased the performance for all of these functions and plot types. + +Support for detrending and windowing 2D arrays in mlab +`````````````````````````````````````````````````````` +Todd Jennings added support for 2D arrays in the +:func:`~matplotlib.mlab.detrend_mean`, :func:`~matplotlib.mlab.detrend_none`, +and :func:`~matplotlib.mlab.detrend`, as well as adding +:func:`~matplotlib.mlab.apply_window` which support windowing 2D arrays. + +Support for strides in mlab +``````````````````````````` +Todd Jennings added some functions to mlab to make it easier to use numpy +strides to create memory-efficient 2D arrays. This includes +:func:`~matplotlib.mlab.stride_repeat`, which repeats an array to create a 2D +array, and :func:`~matplotlib.mlab.stride_windows`, which uses a moving window +to create a 2D array from a 1D array. + +Formatter for new-style formatting strings +`````````````````````````````````````````` +Added `FormatStrFormatterNewStyle` which does the same job as +`FormatStrFormatter`, but accepts new-style formatting strings +instead of printf-style formatting strings + +Consistent grid sizes in streamplots +```````````````````````````````````` +:func:`~matplotlib.pyplot.streamplot` uses a base grid size of 30x30 for both +`density=1` and `density=(1, 1)`. Previously a grid size of 30x30 was used for +`density=1`, but a grid size of 25x25 was used for `density=(1, 1)`. + +Get a list of all tick labels (major and minor) +``````````````````````````````````````````````` +Added the `kwarg` 'which' to :func:`~matplotlib.Axes.get_xticklabels`, +:func:`~matplotlib.Axes.get_yticklabels` and +:func:`~matplotlib.Axis.get_ticklabels`. 'which' can be 'major', 'minor', or +'both' select which ticks to return, like +:func:`~matplotlib.Axis.set_ticks_position`. If 'which' is `None` then the old +behaviour (controlled by the bool `minor`). + +Separate horizontal/vertical axes padding support in ImageGrid +`````````````````````````````````````````````````````````````` +The `kwarg` 'axes_pad' to :class:`mpl_toolkits.axes_grid1.ImageGrid` can now +be a tuple if separate horizontal/vertical padding is needed. +This is supposed to be very helpful when you have a labelled legend next to +every subplot and you need to make some space for legend's labels. + +Support for skewed transformations +`````````````````````````````````` +The :class:`~matplotlib.transforms.Affine2D` gained additional methods +`skew` and `skew_deg` to create skewed transformations. Additionally, +matplotlib internals were cleaned up to support using such transforms in +:class:`~matplotlib.Axes`. This transform is important for some plot types, +specifically the Skew-T used in meteorology. + +.. plot:: mpl_examples/api/skewt.py + +Support for specifying properties of wedge and text in pie charts. +`````````````````````````````````````````````````````````````````` +Added the `kwargs` 'wedgeprops' and 'textprops' to :func:`~matplotlib.Axes.pie` +to accept properties for wedge and text objects in a pie. For example, one can +specify wedgeprops = {'linewidth':3} to specify the width of the borders of +the wedges in the pie. For more properties that the user can specify, look at +the docs for the wedge and text objects. + +Fixed the direction of errorbar upper/lower limits +`````````````````````````````````````````````````` +Larry Bradley fixed the :func:`~matplotlib.pyplot.errorbar` method such +that the upper and lower limits (*lolims*, *uplims*, *xlolims*, +*xuplims*) now point in the correct direction. + +More consistent add-object API for Axes +``````````````````````````````````````` +Added the Axes method `~matplotlib.axes.Axes.add_image` to put image +handling on a par with artists, collections, containers, lines, patches, +and tables. + +Violin Plots +```````````` +Per Parker, Gregory Kelsie, Adam Ortiz, Kevin Chan, Geoffrey Lee, Deokjae +Donald Seo, and Taesu Terry Lim added a basic implementation for violin +plots. Violin plots can be used to represent the distribution of sample data. +They are similar to box plots, but use a kernel density estimation function to +present a smooth approximation of the data sample used. The added features are: + +:func:`~matplotlib.Axes.violin` - Renders a violin plot from a collection of +statistics. +:func:`~matplotlib.cbook.violin_stats` - Produces a collection of statistics +suitable for rendering a violin plot. +:func:`~matplotlib.pyplot.violinplot` - Creates a violin plot from a set of +sample data. This method makes use of :func:`~matplotlib.cbook.violin_stats` +to process the input data, and :func:`~matplotlib.cbook.violin_stats` to +do the actual rendering. Users are also free to modify or replace the output of +:func:`~matplotlib.cbook.violin_stats` in order to customize the violin plots +to their liking. + +This feature was implemented for a software engineering course at the +University of Toronto, Scarborough, run in Winter 2014 by Anya Tafliovich. + +More `markevery` options to show only a subset of markers +````````````````````````````````````````````````````````` +Rohan Walker extended the `markevery` property in +:class:`~matplotlib.lines.Line2D`. You can now specify a subset of markers to +show with an int, slice object, numpy fancy indexing, or float. Using a float +shows markers at approximately equal display-coordinate-distances along the +line. + +Added size related functions to specialized `Collections` +````````````````````````````````````````````````````````` + +Added the `get_size` and `set_size` functions to control the size of +elements of specialized collections ( +:class:`~matplotlib.collections.AsteriskPolygonCollection` +:class:`~matplotlib.collections.BrokenBarHCollection` +:class:`~matplotlib.collections.CircleCollection` +:class:`~matplotlib.collections.PathCollection` +:class:`~matplotlib.collections.PolyCollection` +:class:`~matplotlib.collections.RegularPolyCollection` +:class:`~matplotlib.collections.StarPolygonCollection`). + + +Fixed the mouse coordinates giving the wrong theta value in Polar graph +``````````````````````````````````````````````````````````````````````` +Added code to +:func:`~matplotlib.InvertedPolarTransform.transform_non_affine` +to ensure that the calculated theta value was between the range of 0 and 2 * pi +since the problem was that the value can become negative after applying the +direction and rotation to the theta calculation. + +Simple quiver plot for mplot3d toolkit +`````````````````````````````````````` +A team of students in an *Engineering Large Software Systems* course, taught +by Prof. Anya Tafliovich at the University of Toronto, implemented a simple +version of a quiver plot in 3D space for the mplot3d toolkit as one of their +term project. This feature is documented in :func:`~mpl_toolkits.mplot3d.Axes3D.quiver`. +The team members are: Ryan Steve D'Souza, Victor B, xbtsw, Yang Wang, David, +Caradec Bisesar and Vlad Vassilovski. + +.. plot:: mpl_examples/mplot3d/quiver3d_demo.py + +polar-plot r-tick locations +``````````````````````````` +Added the ability to control the angular position of the r-tick labels +on a polar plot via :func:`~matplotlib.Axes.axes.set_rlabel_position`. + + +Date handling +------------- + +n-d array support for date conversion +`````````````````````````````````````` +Andrew Dawson added support for n-d array handling to +:func:`matplotlib.dates.num2date`, :func:`matplotlib.dates.date2num` +and :func:`matplotlib.dates.datestr2num`. Support is also added to the unit +conversion interfaces :class:`matplotlib.dates.DateConverter` and +:class:`matplotlib.units.Registry`. + + +Configuration (rcParams) +------------------------ + + +``savefig.transparent`` added +````````````````````````````` +Controls whether figures are saved with a transparent +background by default. Previously `savefig` always defaulted +to a non-transparent background. + + +``axes.titleweight`` +```````````````````` +Added rcParam to control the weight of the title + +``axes.formatter.useoffset`` added +`````````````````````````````````` +Controls the default value of `useOffset` in `ScalarFormatter`. If +`True` and the data range is much smaller than the data average, then +an offset will be determined such that the tick labels are +meaningful. If `False` then the full number will be formatted in all +conditions. + +``nbagg.transparent`` added +````````````````````````````` +Controls whether nbagg figures have a transparent +background. ``nbagg.transparent`` is ``True`` by default. + + +XDG compliance +`````````````` +Matplotlib now looks for configuration files (both rcparams and style) in XDG +compliant locations. + +``style`` package added +----------------------- +You can now easily switch between different styles using the new ``style`` +package:: + + >>> from matplotlib import style + >>> style.use('dark_background') + +Subsequent plots will use updated colors, sizes, etc. To list all available +styles, use:: + + >>> print style.available + +You can add your own custom ``