Matplotlib styles for HEP
Project description
A set of helpers for matplotlib to more easily produce plots typically
needed in HEP as well as style them in way that's compatible with current
collaboration requirements (ROOT-like plots for CMS, ATLAS, LHCb).
Installation
pip install mplhep
Getting Started
Styling
import matplotlib.pyplot as plt
import mplhep as hep
plt.style.use(hep.style.ROOT) # For now ROOT defaults to CMS
# Or choose one of the experiment styles
plt.style.use(hep.style.CMS)
# or
plt.style.use(hep.style.ATLAS)
# or
plt.style.use(hep.style.LHCb)
Experiment specific style are also available. If the default styles are not what you need, I'd be happy to merge in new styles or modify the current ones.
Default experiment labels are also available
# Overall - both left and right annotation
hep.<experiment>.label()
# Just experiment label and <text> such as 'Preliminary' or 'Simulation'
hep.<experiment>.text(<text>)
Plotting
1D Histograms
h, bins = [2, 3, 2], [0, 1, 2, 3]
hep.histplot(h, bins)
2D Histograms
import numpy as np
xbins, ybins = [0, 1, 2, 3], [0, 1, 2, 3]
H = np.array([[2,3,2], [1,2,1], [3,1,3]])
hep.hist2dplot(H, xbins, ybins)
Several useful style adjustments differing form mpl defaults are also available separately or within
hep.mpl_magic()
- align axis labels to the right
- Set lower ylim to 0, if no data is obscured
- Autoscale upper ylim to fit legend without overlapping with plots
Basic Use
Styling
Minimal Example
import numpy as np
import matplotlib.pyplot as plt
+ import mplhep as hep
x = np.random.uniform(0, 10, 240)
y = np.random.normal(512, 112, 240)
z = np.random.normal(0.5, 0.1, 240)
+ plt.style.use(hep.style.ROOT)
f, ax = plt.subplots()
ax.scatter(x,y, c=z);
Plotting
A pre-binned histogram plotter is provided, as this functionality is currently
awkward in mpl.
import numpy as np
import matplotlib.pyplot as plt
+ import mplhep as hep
h, bins = np.histogram(np.random.normal(10,3,1000))
f, ax = plt.subplots()
- ax.step(bins, np.r_[h, h[-1]], step='post')
+ hep.histplot(h, bins)
Additional functionality is also wrapped inside.
- if
his a list of arrays or a 2d array, separate histograms will be plotted stack=Truestack plotsyerr={None | True | array of ndim = h.ndim | array of ndim = h.ndim + 1}is available to plot{ no | Poisson | one-sided | two-sided }errors.density=Trueshow densityweightshistype={'step' | 'fill'}edgeswhen plotting with'step'close the shape outside
An effort has been made to provide API as close as possible to plt.hist()
2D Histogram plotter is also included
import numpy as np
import matplotlib.pyplot as plt
import mplhep as hep
fig, ax = plt.subplots()
xedges = [0, 1, 3, 5]
yedges = [0, 2, 3, 4, 6,7]
x = np.random.normal(2, 1, 100)
y = np.random.normal(4, 1, 100)
H, xedges, yedges = np.histogram2d(x, y, bins=(xedges, yedges))
hep.hist2dplot(H, xedges, yedges)
More Information
Available styles:
-
plt.style.use(style.ROOT)- Default (figure 10x10 inches, full column size) -
plt.style.use(style.ROOTlegacy)- Same as ROOT style above, but use ROOT fonts - Helvetica, fallback to Arial - instead of TeX Gyre Heros, requires font to be already available on the system -
plt.style.use(style.ROOTs)- Default (figure 6x6 inches, half column size) -
plt.style.use(style.fira)- use Fira Sans -
plt.style.use(style.firamath)- use Fira Math -
plt.style.use(style.ATLAS)- use default ATLAS style from https://github.com/kratsg/ATLASstylempl, note it defaults to Helvetica, which is not supplied in this package as explained below, and will only work properly if already available on the system
Styles can be chained:
- e.g.
plt.style.use([style.ROOT, style.fira, style.firamath]) - reappearing rcParams get overwritten silently
Styles can be modified on the fly
- Since styles are dictionaries and they can be chained/overwritten they can be easiely modified on the fly. e.g.
plt.style.use(style.ROOT)
plt.style.use({"font.sans-serif":'Comic Sans MS'})
Styling with LaTeX
plt.style.use(style.ROOTtex)- Use LaTeX to produce all text labels- Requires having the full tex-live distro
- True Helvetica
- Use sansmath as the math font
- Takes longer and not always better
- In general more possibilities, but a bit more difficult to get everything working properly
Experiment annotations
+ plt.style.use(hep.cms.style.ROOT)
+ ax = hep.cms.cmslabel(data=False, paper=False, year='2017', ax=ax)
Plot helper functions
Box (or other) aspect
Square plot with subplot (works with tight_layout())
Append a new axes, without modifying the original
Notes
Consistency & Fonts
As it is ROOT does not come with any fonts and therefore relies on using system fonts. Therfore the font in a figure can be dependent on whether it was produced on OSX or PC. The default sans-serif font used is Helvetica, but it only comes with OSX, in Windows this will silently fallback to Arial.
License
Both Helvetica and Arial are proprietary, which as far as fonts go means you can use it to create any text/graphics once you have the license, but you cannot redistribute the font files as part of other software. That means we cannot just package Helvetica with this to make sure everyone has the same font in plots.
Luckily for fonts it seems only the software is copyrighted, not the actual shapes, which means there are quite a few open alternatives with similar look. The most closely resembling Helvetica being Tex Gyre Heros
Tex Gyre Heros
http://www.gust.org.pl/projects/e-foundry/tex-gyre/heros
You can compare yourself if the differences are meanigful below.
They are Tex Gyre Heros, Helvetica and Arial respecively.
Math Fonts
- Math fonts are a separate set from regular fonts due to the amount of special characters
- It's not trivial to make sure you get a matching math font to your regular font
- Most math-fonts are serif fonts, but this is not ideal if one wants to use sans-serif font for normal text like Helvetica or Arial
- The number of sans-serif math-fonts is very limited
- The number of open sans-serif math-fonts is extremely limited
- Basically there's two, Fira Sans and GFS Neohellenic Math, of which I like Fira Sans better
- https://tex.stackexchange.com/questions/374250/are-there-opentype-sans-math-fonts-under-development
For consistent styling Fira Sans is included as well.
Default Fira Sans
https://github.com/mozilla/Fira
Math font extension
https://github.com/firamath/firamath
What doesn't work
Context styles and fonts
with pyplot.style.context(style.ROOT):
plotting...
- This syntax would be ideal, however, it doesn't work properly for fonts and there are no plans by mpl devs to fix this behaviour https://github.com/matplotlib/matplotlib/issues/11673
For now one has to set the style globally
plt.style.use(style.ROOT)
Use in publications
Updating list of citations and use cases of mplhep in publications:
- Simultaneous Jet Energy and Mass Calibrations with Neural Networks, ATLAS Collaboration, 2019
- Integration and Performance of New Technologies in the CMS Simulation, Kevin Pedro, 2020 (Fig 3,4)
- GeantV: Results from the prototype of concurrent vector particle transport simulation in HEP, Amadio et al, 2020 (Fig 25,26)
- Search for the standard model Higgs boson decaying to charm quarks, CMS Collaboration, 2019 (Fig 1)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mplhep-0.1.25.tar.gz.
File metadata
- Download URL: mplhep-0.1.25.tar.gz
- Upload date:
- Size: 5.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8d66a2799fb448c8286e42d527f127a04a4ea1c992e57a3f6c5679dfd93c22b8 |
|
| MD5 | adf97b7cdb7fa615d03f6cc962127761 |
|
| BLAKE2b-256 | 4bfd0ed9224e5d3fd15338a04e0cad7cf5d0dd05e4524ef3c3a6e7ee5730b086 |
File details
Details for the file mplhep-0.1.25-py3-none-any.whl.
File metadata
- Download URL: mplhep-0.1.25-py3-none-any.whl
- Upload date:
- Size: 5.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7b194adb87dc62275754fef0b9410fd12f27b7c5ef92fbfb03aa5a9ed76b9135 |
|
| MD5 | d14258cdd37375b8cc0cd1e74673a8ae |
|
| BLAKE2b-256 | 5c3e518ab1fb1774a73fa3a50f49e1606a2938d55ec87807bf0d33d59e25f6f7 |
