Interfaces and Integrations

Uhepp has been integrated into multiple frameworks or packages. This page maintains a list of third-party software that interfaces with uhepp.

Common Analysis Framework

The Common Analysis Framework, or CAF, is an event processing framework used within the ATLAS collaboration to study data produced at the LHC. CAF provides a custom uhepp-compatible plotter that generates JSON files instead of graphics formats and optionally uploads the plot to uhepp.org. To use the plotter, add the following lines to your visualize configuration.

plotter: uhepp
plotFormats: json
# Collection id, e.g. 1
plotter.uhepp.collection: 1

FreeForestML

The FreeForestML framework (formally nnfwtbn), is a python-based event processing framework with a focus on neural network training. The default plotting environment in FreeForestML is based on uhepp and exposes the internal objects with the return_uhepp=True flag. The following example is a modified version of this example to show how to push a histogram to a collection.

plot = hist(df, v_higgs_m, 20, [s_bkg, s_data], range=(0, 200), selection=None,
            weight="weight",  ratio_label="Data / SM", return_uhepp=True)
# plot is a uhepp histogram
plot.show()
plot.push(1)

The FreeForestML also has a dedicated example Notebook to illustrate the uhepp integration.

Latex

Using plots stored on uhepp hub in a latex document involves the following steps: Downloading the plot, rendering the plot, adding the includegraphics command to the latex document. With the following snippet, you can automate this procedure and add plots directly using the plot’s uuid.

Add this snippet in the preamble of your document:

\newcommand{\includeuhepp}[2]{
  \immediate\write18{mkdir -p .uhepp_cache}
  \immediate\write18{test -f .uhepp_cache/#2.json || uhepp pull #2 .uhepp_cache/#2.json}
  \immediate\write18{test -f .uhepp_cache/#2.pdf  || uhepp render .uhepp_cache/#2.json .uhepp_cache/#2.pdf}
  \includegraphics[width=#1\textwidth]{.uhepp_cache/#2.pdf}
}

Embed plots with:

\includeuhepp{1.0}{a378d2b0-cde2-4266-be9b-85945d94880d}