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
- (perturbative) orders, represented by the type
Orderand accessible byGrid::orders(), - bins, whose limits can be accessed by
Grid::bin_info(), and - 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,Orderand 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
Gridtrait with n-tuples. - pids
- TODO
- sparse_
array3 - Module containing the
SparseArray3struct. - subgrid
- Module containing the trait
Subgridand supporting structs.