User Guide

Welcome to the mplhep user guide! This documentation is organized into focused sections to help you find what you need quickly.

Prerequisites

Throughout this guide the following codeblock is assumed.

import matplotlib.pyplot as plt
import numpy as np
import hist
np.random.seed(42)
import mplhep as mh
mh.style.use('<as appropriate>')

Histogram Plotting

Functions for 1D and 2D pre-binned histograms with support for the Unified Histogram Interface (UHI).

• 1D Histogram Plotting
  • Supported Input Formats
  • Histogram Styles
  • Multiple Histograms
  • Error Bars
  • Normalization Options
• 2D Histograms

Comparison Plotting

High-level functions for data-model comparisons.

• Compare two histograms
• Data-MC comparison
  • Showcasing more options
• Additional examples

Styling

Official styles for ATLAS, CMS, LHCb, ALICE, and DUNE experiments.

• Setting experiment styles
• Setting experiment labels
• Configuring experiment labels

Utilities

Utility functions and experiment-specific label formatters.

• Text placement
• Subplot creation
• Save variations
• Fit y-label
• mpl_magic
• Axes manipulation
• plt.hist wrapper

To go further

UHI integration and best practices.

• Working with UHI Histograms
• Best practices

More Info

• API Reference - Detailed documentation of all functions and parameters
• Gallery - Visual examples of all plot types
• Contributing - Information on development and testing