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

Use the NNPDF data instead of yamldb #159

Merged
merged 14 commits into from
Mar 26, 2024
23 changes: 19 additions & 4 deletions docs/source/overview/prerequisites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ This is a standard example:

::

[general]
nnpdf = true

[paths]
# inputs
ymldb = "data/yamldb"
grids = "data/grids"
theory_cards = "data/theory_cards"
operator_card_template_name = "_template.yaml"
Expand All @@ -30,10 +32,23 @@ This is a standard example:

All the relevant inputs are described below. The command ``pineko scaffold new`` will generate all necessary folders.

*ymldb*
-------
nnpdf
-----
The key ``nnpdf`` tells ``pineko`` it should use the data files from NNPDF to map datasets to FK Tables.
If this key is given, a valid installation of ``nnpdf`` needs to be available as well.
i.e, ``pineko`` should be installed with the ``nnpdf`` extra (``pip install pineko[nnpdf]``).

Alternatively, it is possible not to set this key (or set it to false) and instead
provide a path with ``yaml`` files containing such dataset-FK mapping.
If a custom database of mappings is to be used, the path to the folder containing
this files needs to be explicitly provided:

::

[paths]
ymldb = "data/yamldb"

You need all files of the *ymldb* [2]_ which define the mapping from datasets to FK tables.
This *ymldb* [2]_ defines the mapping from datasets to FK tables.
scarlehoff marked this conversation as resolved.
Show resolved Hide resolved
An actual (rather simple) example is the following:

::
Expand Down
Loading