Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List of metadata for pineappl grids #64

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/source/external/matrix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
MATRIX
======


Post-processing grids
---------------------

We need to post-process the raw grids outputted by MATRIX -
use one of the available interfaces (including the CLI) to do so.


- **Optimize and scale:** apply the built-in optimization and rescaled by a factor if needed to go e.g. from pb to fb.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that is useless

  • don't tell me what the pineappl interface does
  • you may want to write "since MATRIX is not doing the optimazation yet, remember to do it here" and then you should complain with MATRIX
  • you may want to write "MATRIX outputs by default in fb, so remember to rescale"


- **Delete keys:** delete `y_label_unit`, `xlabel` and `x_label-tex`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deleting keys is wrong, we need those! you may want to overwrite ...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, these keys have to be deleted! Pineappl uses x1_label, x1_label_tex, x1_unit, y_label, y_label_tex, y_unit, so keys like 'x_label', 'x_label_tex', 'x_unit_label' and 'y_label_unit' indeed have to be deleted and new keys with correct names have to be manually set. this wrong labelling of keys is a typo in matrix.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine, but then you realize that precisely such information should be in the docs


- **Add keys:**
.. list-table:: Additional keys
:widths: 25 25 50
:header-rows: 1

* - key
- value
- comment
* - y-unit
- pb/GeV
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that is useless - this information is grid dependent

-
* - y-label
- differential x-sec
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this does not follow our convention

-
* - lumi_id_types
- pdg_mc_ids
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again you want to write "since MATRIX is not doing this by default, remember to add it" and then complain with MATRIX

- needed for compatibility with LHAPDF
* - arxiv
-
- put the original paper

- **Add output log of MATRIX:** put the original MATRIX output log under the `results` key as usual
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ and the program will, if necessary, install the required external program and la
external/index
external/mg5
external/yadism
external/matrix
external/vrap
external/pos
external/int
Expand Down
Loading