Skip to main content

Crate pineappl_v0

Crate pineappl_v0 

Source
Expand description

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::channels().

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
boc
Module containing structures for the 3 dimensions of a [Grid]: bins, Order and channels (boc).
convolutions
Module for everything related to luminosity functions.
empty_subgrid
TODO
grid
Module containing all traits and supporting structures for grids.
import_only_subgrid
TODO
lagrange_subgrid
Module containing the Lagrange-interpolation subgrid.
ntuple_subgrid
Provides an implementation of the Grid trait with n-tuples.
pids
TODO
sparse_array3
Module containing the SparseArray3 struct.
subgrid
Module containing the trait Subgrid and supporting structs.