Crate pineappl

PineAPPL is not an extension of APPLgrid.

Overview

The main type of this crate is Grid, which represents the interpolation grids that PineAPPL implements. Roughly speaking, a Grid is a three-dimensional array of Subgrid objects together with metadata. The three dimensions are

1. (perturbative) orders, represented by the type Order and accessible by Grid::orders(),
2. bins, whose limits can be accessed by Grid::bin_info(), and
3. channels, whose definition is returned by Grid::lumi(). Note that in older parts of PineAPPL channels are often also called ‘luminosities’ or ‘lumi’.

Subgrid is a trait and objects that implement it are of the type SubgridEnum. The latter is an enum of different types that are optimized to different scenarios: fast event filling, small storage profile, etc.

Metadata

Metadata is a collection of key–value pairs, in which both keys and values are String objects. In metadata anything a user whishes can be stored. However, there are special keys, which have meaning to PineAPPL and/or its CLI pineappl. This metadata enables the CLI to automatically generate plots that are correctly labeled, for instance. For more applications see also the CLI tutorial.

Modules

• bin
  Module that contains helpers for binning observables
• empty_subgrid
  TODO
• evolution
  Supporting classes and functions for Grid::evolve.
• fk_table
  Provides the FkTable type.
• grid
  Module containing all traits and supporting structures for grids.
• import_only_subgrid
  TODO
• lagrange_subgrid
  Module containing the Lagrange-interpolation subgrid.
• lumi
  Module for everything related to luminosity functions.
• ntuple_subgrid
  Provides an implementation of the Grid trait with n-tuples.
• packed_array
  Provides the PackedArray struct.
• pids
  TODO
• sparse_array3
  Module containing the SparseArray3 struct.
• subgrid
  Module containing the trait Subgrid and supporting structs.

Macros

• lumi_entry
  Helper macro to quickly generate a LumiEntry at compile time.