Add solarized palette as named colors #11927

josesho · 2018-08-24T05:23:46Z

PR Summary

Adds Ethan Schoonover's 16-color Solarized palette as named colors to matplotlib. They can be accessed by appending 'solarized:' to the relevant color name.

PR Checklist

Has Pytest style unit tests
Code is Flake 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

timhoffm

Thanks for your contribution.

There are a few minor style issues. Otherwise good to go.

timhoffm · 2018-08-24T06:10:32Z

examples/color/named_colors.py

@@ -16,7 +16,8 @@
 from matplotlib import colors as mcolors


-colors = dict(mcolors.BASE_COLORS, **mcolors.CSS4_COLORS)
+colors = dict(mcolors.BASE_COLORS, **mcolors.CSS4_COLORS,
+                **mcolors.SOLARIZED_COLORS)


Please align the continued line with the inside I’d the parentheses, I.e. remove two spaces.

timhoffm · 2018-08-24T06:12:01Z

lib/matplotlib/_color_data.py

+# Copyright (c) 2011 Ethan Schoonover
+SOLARIZED_COLORS = {
+    'solarized-base03':              '#002b36',
+    'solarized-base02':              '#073642',


Please align the color values with the color values of the CSS colors above.

timhoffm · 2018-08-24T06:23:57Z

lib/matplotlib/colors.py

@@ -50,7 +50,8 @@

 import numpy as np
 import matplotlib.cbook as cbook
-from ._color_data import BASE_COLORS, TABLEAU_COLORS, CSS4_COLORS, XKCD_COLORS
+from ._color_data import BASE_COLORS, TABLEAU_COLORS, CSS4_COLORS, \


For multi-line imports we prefer enclosing in brackets over line-continuation characters, i.e.

from ._color_data import (BASE_COLORS, TABLEAU_COLORS, CSS4_COLORS, XKCD_COLORS, SOLARIZED_COLORS)

anntzer · 2018-08-24T08:15:22Z

lib/matplotlib/_color_data.py

+# License: https://github.com/altercation/solarized/blob/master/LICENSE
+# Copyright (c) 2011 Ethan Schoonover
+SOLARIZED_COLORS = {
+    'solarized-base03':              '#002b36',


The namespacing method we use (cf. xkcd, tab) is "solarized:base03" (colon), not "solarized-base03" (dash).
Anyone can dismiss this once handled.

josesho · 2018-08-24T09:16:24Z

@timhoffm @anntzer Have addressed your comments; thanks for the review.

handled

jklymak · 2018-08-24T22:07:57Z

This largely seems good to me, but
https://12757-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/gallery/color/named_colors.html#sphx-glr-gallery-color-named-colors-py

doesnt' seem an optimal way to display these. Also, Tableau colors are not displayed. Maybe each color group should get its own subsection?

Display Tableau colors, and now each color group should get its own figure

josesho · 2018-08-25T06:53:43Z

@jklymak Have updated the named colors example to address your suggestions. Let me know if it's OK!

timhoffm

The idea of adding separate sections for the different color groups is great. However the current implementation is not sufficient IMHO. I expect all texts to be of the same font size. Also the color patches should all be of the same size and at best even be aligned across the groups.

https://12789-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/gallery/color/named_colors.html?highlight=visualizing%20named

You may improve this here or split it into another PR, if that's easier.

josesho · 2018-08-25T16:48:49Z

Noted, look our for a new PR here!

timhoffm · 2018-08-26T19:57:47Z

It's really a bit difficult to exactly control sizes and positions in such a plot. Try this for the color table:

import matplotlib.pyplot as plt
from matplotlib.colors import rgb_to_hsv, to_rgba

def plot_colortable(colors, title, sort_colors=True, ncols=4):
    extra_rows = 2  # additional space for title
    cell_width = 225
    cell_height = 30
    swatch_width = 50
    
    # Sort colors by hue, saturation, value and name.
    by_hsv = ((tuple(rgb_to_hsv(to_rgba(color)[:3])), name)
                    for name, color in colors.items())
    if sort_colors is True:
        by_hsv = sorted(by_hsv)
    names = [name for hsv, name in by_hsv]

    n = len(names)
    nrows = (n + 1) // ncols

    width = cell_width * ncols
    height = cell_height * (nrows + extra_rows)
    dpi = 72
    fig, ax = plt.subplots(figsize=(width / dpi, height / dpi), dpi=dpi)
    
    ax.set_xlim(0, width)
    ax.set_ylim(height, 0)
    ax.yaxis.set_visible(False)
    ax.xaxis.set_visible(False)
    ax.set_axis_off()
    ax.text(0, cell_height, title, fontsize=20)
    
    for i, name in enumerate(names):
        row = i % nrows
        col = i // nrows
        y = (row + extra_rows) * cell_height

        swatch_start_x = cell_width * col
        swatch_end_x = cell_width * col + swatch_width
        text_pos_x = cell_width * col + swatch_width + 5

        ax.text(text_pos_x, y, name, fontsize=12,
                horizontalalignment='left',
                verticalalignment='center')

        ax.hlines(y, swatch_start_x, swatch_end_x,
                  color=colors[name], linewidth=20)
    plt.show()

plot_colortable(mcolors.BASE_COLORS, "Base Colors", sort_colors=False, ncols=3)
plot_colortable(mcolors.CSS4_COLORS, "CSS Colors")
plot_colortable(mcolors.SOLARIZED_COLORS, "Solarized Palette", sort_colors=False)
plot_colortable(mcolors.TABLEAU_COLORS, "Tableau Palette")

josesho · 2018-08-27T03:19:42Z

OK, added a few tweaks to your update as well.

josesho · 2018-08-27T04:12:13Z

Tangent: Adding the Solarized palette led me to discover that Tableau updated their color palette in 2016.

Not sure if it's worth it to update the colors? (Not in this PR, of course.) I myself don't personally use Tableau or its palette, so the benefits are unclear to me.

ImportanceOfBeingErnest · 2018-08-29T21:30:22Z

The list of which options there are to specify colors in matplotlib appears in three places:

Ultimately one would need to update all three tables with the new solarized:... colors.
This can also be a new PR of course, I just wanted to meantion it not to be forgotten.

Additional question: Do the "Accent colors" qualify to create a new listed (discrete) colormap from them, similar to how "tableau" colors are in the "tab10" colormap?

Sorting of the named colors example handled separately.

timhoffm · 2018-10-13T15:37:27Z

@josesho still interested in adding solarized colors? The color sorting has been handled separately in #12209. So this PR can be simplified again.

Please note also, that we do not write to whats_new.rst directly because it would create a lot of conflicts. You should instead create a separate file for the entry as described in https://github.com/matplotlib/matplotlib/tree/master/doc/users/next_whats_new.

ImportanceOfBeingErnest · 2018-10-13T16:21:31Z

Relevant here: #12009 (comment). Essentially adding new named colors has been discussed in a monday's call and the overall opinion (though not shared by everyone) was not to add too many of them. So I'm not sure in how far this applies here.

josesho · 2018-10-15T01:45:43Z

I'll have a look at #12209 and modify this PR accordingly. 👌

jklymak · 2019-02-26T00:19:21Z

ping @josesho: Pushing to 3.2, but feel free to update when you get a chance...

jklymak

As discussed in #12009, more and more "named colors" has to stop somewhere. The idea behind this PR is great, but we need a way to organize these custom lists better....

josesho · 2019-03-04T14:59:10Z

Been snowed under with work but let me get back to this and see what I need to do!

jklymak · 2019-03-04T15:28:33Z

Sorry I should have been clearer; we need some sort of way to manage these lists of named colors. Otherwise we will have hundreds of them.

anntzer · 2019-08-28T10:30:20Z

More or less in the same way as for the colormap discussion in some other thread, this could basically be implemented as a third-party package. In fact a quick googling shows that there's already https://pypi.org/project/pygments-solarized/ which exposes the desired colors in #rrggbb format:

from pygments_solarized import dark as sol
plt.plot([1, 2], c=sol.MAGENTA)

which is not much worse than "solarized:magenta"...
Hence I am tempted to just close this.

tacaswell · 2019-08-29T21:11:27Z

@josesho Could you put a note about this in the color docs?

josesho added 5 commits August 24, 2018 13:15

add Solarized palette

63b8b65

add import solarized colors

befad3c

add solarized colors to named color example

b1e9b57

add Solarized palette writeup to whats_new

22f03ee

fix typo

1e5ec15

timhoffm reviewed Aug 24, 2018

View reviewed changes

timhoffm added this to the v3.1 milestone Aug 24, 2018

anntzer previously requested changes Aug 24, 2018

View reviewed changes

josesho added 3 commits August 24, 2018 17:13

align dict with above dict; change "solarized-" to "solarized:"

b329729

align import

1dc142d

align within parenthesis

c5cd04b

fix reference to solarized colors

4f766d3

timhoffm approved these changes Aug 24, 2018

View reviewed changes

update named colors example

e37e84c

Display Tableau colors, and now each color group should get its own figure

timhoffm previously requested changes Aug 25, 2018

View reviewed changes

align swatches; standardize swatch size and font size

72716ab

better control of grid layout

cec44bb

josesho added 4 commits August 27, 2018 11:26

fix missing mcolors.

57c7d00

code lint

da7d5be

removed unused functions in references

36d14cb

add descriptions as inline comments

7d9f670

josesho added 6 commits August 29, 2018 23:09

moved solarized writeup from whats_new to next_whats_new

59761d7

add mention of Solarized to colors.py module docstring

d4f109e

fix typo

fa9fda5

fix another typo

cf70a3d

fix identation in docstring

88c05e7

fix broekn rst hyperlink

6dbfb50

josesho added 2 commits August 30, 2018 09:51

add solarized description to docstring

00f5c60

uncomment next_whats_new TOC chunk

3dabeae

ImportanceOfBeingErnest mentioned this pull request Sep 3, 2018

Introduce new Tableau colors #12009

Closed

6 tasks

ImportanceOfBeingErnest mentioned this pull request Sep 22, 2018

Doc: Sort named colors example by palette #12209

Merged

2 tasks

timhoffm added the status: needs revision label Oct 13, 2018

jklymak modified the milestones: v3.1.0, v3.2.0 Feb 26, 2019

jklymak requested changes Feb 26, 2019

View reviewed changes

jklymak added the topic: color/color & colormaps label Feb 26, 2019

tacaswell modified the milestones: v3.2.0, v3.3.0 Aug 28, 2019

josesho closed this Aug 29, 2019

tacaswell modified the milestones: v3.3.0, unassigned Aug 29, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add solarized palette as named colors #11927

Add solarized palette as named colors #11927

josesho commented Aug 24, 2018 •

edited

Loading

timhoffm left a comment

timhoffm Aug 24, 2018

timhoffm Aug 24, 2018

timhoffm Aug 24, 2018

anntzer Aug 24, 2018 •

edited

Loading

josesho commented Aug 24, 2018 •

edited

Loading

jklymak commented Aug 24, 2018 •

edited

Loading

josesho commented Aug 25, 2018

timhoffm left a comment

josesho commented Aug 25, 2018

timhoffm commented Aug 26, 2018 •

edited

Loading

josesho commented Aug 27, 2018

josesho commented Aug 27, 2018

ImportanceOfBeingErnest commented Aug 29, 2018

timhoffm commented Oct 13, 2018

ImportanceOfBeingErnest commented Oct 13, 2018

josesho commented Oct 15, 2018

jklymak commented Feb 26, 2019

jklymak left a comment •

edited

Loading

josesho commented Mar 4, 2019

jklymak commented Mar 4, 2019

anntzer commented Aug 28, 2019

tacaswell commented Aug 29, 2019

Add solarized palette as named colors #11927

Add solarized palette as named colors #11927

Conversation

josesho commented Aug 24, 2018 • edited Loading

PR Summary

PR Checklist

timhoffm left a comment

Choose a reason for hiding this comment

timhoffm Aug 24, 2018

Choose a reason for hiding this comment

timhoffm Aug 24, 2018

Choose a reason for hiding this comment

timhoffm Aug 24, 2018

Choose a reason for hiding this comment

anntzer Aug 24, 2018 • edited Loading

Choose a reason for hiding this comment

josesho commented Aug 24, 2018 • edited Loading

jklymak commented Aug 24, 2018 • edited Loading

josesho commented Aug 25, 2018

timhoffm left a comment

Choose a reason for hiding this comment

josesho commented Aug 25, 2018

timhoffm commented Aug 26, 2018 • edited Loading

josesho commented Aug 27, 2018

josesho commented Aug 27, 2018

ImportanceOfBeingErnest commented Aug 29, 2018

timhoffm commented Oct 13, 2018

ImportanceOfBeingErnest commented Oct 13, 2018

josesho commented Oct 15, 2018

jklymak commented Feb 26, 2019

jklymak left a comment • edited Loading

Choose a reason for hiding this comment

josesho commented Mar 4, 2019

jklymak commented Mar 4, 2019

anntzer commented Aug 28, 2019

tacaswell commented Aug 29, 2019

josesho commented Aug 24, 2018 •

edited

Loading

anntzer Aug 24, 2018 •

edited

Loading

josesho commented Aug 24, 2018 •

edited

Loading

jklymak commented Aug 24, 2018 •

edited

Loading

timhoffm commented Aug 26, 2018 •

edited

Loading

jklymak left a comment •

edited

Loading