1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
//! `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.
//!
//! [`Grid`]: grid::Grid
//! [`Grid::bin_info()`]: grid::Grid::bin_info
//! [`Grid::channels()`]: grid::Grid::channels
//! [`Grid::orders()`]: grid::Grid::orders
//! [`Subgrid`]: subgrid::Subgrid
//! [`SubgridEnum`]: subgrid::SubgridEnum
//! [`Order`]: order::Order
//!
//! ## 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].
//!
//! [special keys]: https://nnpdf.github.io/pineappl/docs/metadata.html
//! [CLI tutorial]: https://nnpdf.github.io/pineappl/docs/cli-tutorial.html