feat!: updating ATLAS color palette to match collboration recommendations (#574)

* Updating ATLAS color palette

After an internal working group to discuss color palette options and
color-vision deficiency of various kinds, these are the proposed colors
that the experiment will adopt.

* Attempting updates following review

Giving a few things a try here:
- Breaking out ATLAS style into ATLAS1 and ATLAS2
- Copying styles around a bit
- Keeping the old (disfavored) color scheme
- Linking to documentation for ATLAS members
- Updating the mplhep documentation itself

I hope I got all this right, but further comment is always welcome.

* Adding quotes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Imports

* Updating documentation and colors again in advance of the presentation

It appears that the working group has re-converged, but there will be an
additional discussion this week on the palettes, and probably we should
resist the temptation to merge this until then. Review is of course
welcome nevertheless.

* An additional style without the read

* Updating ATLAS color palettes with final recommendations

We believe these are now the final recommendations of the collaboration.

* Spelling mistake

* Spelling mistake

* Adding ATLAS1 and ATLAS2 explicitly to the styles to be built for the gallery

* Adding links to documentation

* Another place where the styles need to be listed...

---------

Co-authored-by: Zach Marshall <[email protected]>
Co-authored-by: Zach Marshall <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Andrzej Novak <[email protected]>

Author: 5 people

docs/source/gallery/index.rst

@@ -32,7 +32,7 @@ Gallery
     #             and s != "LHCb"  # we want LHCb1 or LHCb2
     #     ]
     # the upper one contains all possible styles, needed?
-    allstyle = ["ATLAS", "ATLASAlt", "CMS", "LHCb1", "LHCb2", "ALICE"]
+    allstyle = ["ATLAS1", "ATLAS2", "CMS", "LHCb1", "LHCb2", "ALICE"]
     allstyle = sorted(allstyle, key=lambda s: s.lower())
     # allstyle = sorted(allstyle, key=lambda s: s.lower().endswith("tex"))
     allstyle = sorted(allstyle, key=lambda s: s.lower().endswith("alt"))

docs/source/gallery/styles.rst

@@ -27,33 +27,34 @@ to illustrate the visual appearance of the styles.
 ATLAS
 ------------
 
-ATLAS has two styles, the default one and the alternative one.
+ATLAS has two `recommended styles <https://twiki.cern.ch/twiki/bin/view/AtlasProtected/PubComPlotStyle#Color_vision_deficiency_palette>`__.
+The main recommendation, ``ATLAS`` (or ``ATLAS2``, based on `this work <https://jfly.uni-koeln.de/color/>`__) provides 7 colors,
+with Vermilion, the first color in the palette, recommended for signal. In the case of large signals, white can also be used.
 
-
-.. image:: ../../_static/_generated/ATLAS/fill/pos0.png
+.. image:: ../../_static/_generated/ATLAS2/fill/pos0.png
    :width: 45%
 
-.. image:: ../../_static/_generated/ATLAS/step/pos0.png
+.. image:: ../../_static/_generated/ATLAS2/step/pos0.png
     :width: 45%
 
-.. image:: ../../_static/_generated/ATLAS/errorbar/pos0.png
+.. image:: ../../_static/_generated/ATLAS2/errorbar/pos0.png
     :width: 45%
 
-.. image:: ../../_static/_generated/ATLAS/band/pos0.png
+.. image:: ../../_static/_generated/ATLAS2/band/pos0.png
     :width: 45%
 
-ATLAS alternative, named ``ATLASAlt``
+For plots that require large numbers of colors, the ``ATLAS1`` palette is provided with 10 colors `based on this paper <https://arxiv.org/pdf/2107.02270>`__.
 
-.. image:: ../../_static/_generated/ATLASAlt/fill/pos0.png
+.. image:: ../../_static/_generated/ATLAS1/fill/pos0.png
    :width: 45%
 
-.. image:: ../../_static/_generated/ATLASAlt/step/pos0.png
+.. image:: ../../_static/_generated/ATLAS1/step/pos0.png
     :width: 45%
 
-.. image:: ../../_static/_generated/ATLASAlt/errorbar/pos0.png
+.. image:: ../../_static/_generated/ATLAS1/errorbar/pos0.png
     :width: 45%
 
-.. image:: ../../_static/_generated/ATLASAlt/band/pos0.png
+.. image:: ../../_static/_generated/ATLAS1/band/pos0.png
     :width: 45%
 
 CMS

src/mplhep/styles/__init__.py

@@ -8,7 +8,7 @@
 
 # Short cut to all styles
 from .alice import ALICE
-from .atlas import ATLAS, ATLASAlt, ATLASTex
+from .atlas import ATLAS, ATLAS1, ATLAS2, ATLASAlt, ATLASTex
 from .cms import CMS, ROOT, CMSTex, ROOTTex
 from .lhcb import LHCb, LHCb1, LHCb2, LHCbTex, LHCbTex1, LHCbTex2
 from .plothist import PLOTHIST
@@ -19,6 +19,8 @@
     "CMS",
     "PLOTHIST",
     "ROOT",
+    "ATLAS1",
+    "ATLAS2",
     "ATLASAlt",
     "ATLASTex",
     "CMSTex",

src/mplhep/styles/atlas.py

@@ -6,7 +6,9 @@
 from cycler import cycler
 
 # Color wheel from https://arxiv.org/pdf/2107.02270 Table 1, 10 color palette
-color_sequence = [
+# This is the color wheel recommended for plots that require a large number
+# of colors that would not be satisfied by the below palette
+color_sequence1 = [
     "#3f90da",
     "#ffa90e",
     "#bd1f01",
@@ -19,6 +21,20 @@
     "#92dadd",
 ]
 
+# Color wheel based on internal discussions of optimal
+# colors for visibility, accounting for color vision deficiency
+# The recommendation for signal is the first color (Vermilion)
+# For large signals, ROOT.kWhite / '#ffffff' is also an option
+color_sequence2 = [
+    "#d55e00",
+    "#56b4e9",
+    "#e69f00",
+    "#f0e442",
+    "#009e73",
+    "#cc79a7",
+    "#0072b2",
+]
+
 _base = {
     # fonts and text
     # initially from https://github.com/kratsg/ATLASstylempl
@@ -49,7 +65,6 @@
     "figure.subplot.left": 0.16,
     "figure.subplot.right": 0.95,
     # axes
-    "axes.prop_cycle": cycler("color", color_sequence),
     "axes.titlesize": "xx-large",
     "axes.labelsize": "x-large",
     "axes.linewidth": 1,
@@ -106,8 +121,22 @@
     "savefig.transparent": False,
 }
 
-ATLAS: dict[str, Any] = {
+ATLAS1: dict[str, Any] = {
     **_base,
+    "axes.prop_cycle": cycler("color", color_sequence1),
+    "mathtext.fontset": "custom",
+    "mathtext.rm": "TeX Gyre Heros",
+    "mathtext.bf": "TeX Gyre Heros:bold",
+    "mathtext.sf": "TeX Gyre Heros",
+    "mathtext.it": "TeX Gyre Heros:italic",
+    "mathtext.tt": "TeX Gyre Heros",
+    "mathtext.cal": "TeX Gyre Heros",
+    "mathtext.default": "it",
+}
+
+ATLAS2: dict[str, Any] = {
+    **_base,
+    "axes.prop_cycle": cycler("color", color_sequence2),
     "mathtext.fontset": "custom",
     "mathtext.rm": "TeX Gyre Heros",
     "mathtext.bf": "TeX Gyre Heros:bold",
@@ -121,12 +150,13 @@
 # use dejavusans (default math fontset)
 ATLASAlt: dict[str, Any] = {
     **_base,
+    "axes.prop_cycle": cycler("color", color_sequence1),
     "mathtext.default": "it",
 }
 
 # use LaTeX
 ATLASTex: dict[str, Any] = {
-    **_base,
+    **ATLAS2,
     "text.usetex": True,
     "text.latex.preamble": "\n".join(
         [
@@ -144,6 +174,10 @@
 }
 
 # Filter extra (labellocation) items if needed
-ATLAS = {k: v for k, v in ATLAS.items() if k in mpl.rcParams}
+ATLAS1 = {k: v for k, v in ATLAS1.items() if k in mpl.rcParams}
+ATLAS2 = {k: v for k, v in ATLAS2.items() if k in mpl.rcParams}
 ATLASAlt = {k: v for k, v in ATLASAlt.items() if k in mpl.rcParams}
 ATLASTex = {k: v for k, v in ATLASTex.items() if k in mpl.rcParams}
+
+# Alias 'ATLAS' to the one that most folks should use
+ATLAS = ATLAS2.copy()