kfactor maintenance and documentation

benchmarks/bench_cli.py

@@ -113,18 +113,15 @@ def benchmark_scaffold_cli(test_empty_proj):
     assert "Success: All the folders are correctly configured" in res.output
 
 
-def benchmark_gen_sv_cli(test_files, tmp_path, test_pdf, lhapdf_path):
+def benchmark_gen_sv_cli(test_files, tmp_path):
     runner = CliRunner()
-    pdf_name = "NNPDF40_nlo_as_01180"
     max_as = "2"
     nf = "5"
     name_grid = "ATLAS_TTB_8TEV_LJ_TRAP_norensv_fixed.pineappl.lz4"
     grid_path = test_files / "data" / "grids" / "400" / name_grid
     new_grid_path = tmp_path / name_grid
     target_path = tmp_path
     shutil.copy(grid_path, new_grid_path)
-    with lhapdf_path(test_pdf):
-        pdf = lhapdf.mkPDF(pdf_name)
     res = runner.invoke(
         command,
         ["ren_sv_grid", str(new_grid_path), str(target_path), max_as, nf, "False"],
@@ -137,7 +134,7 @@ def benchmark_kfactor_cli(test_files, tmp_path):
     grid_folder = test_files / "data" / "grids" / "400"
     kfolder = test_files / "data" / "kfactors"
     fake_yaml_path = test_files / "data" / "yamldb" / "ATLAS_TTB_FAKE.yaml"
-    max_as = "3"
+    ordr_to_update = "3"
     target_path = tmp_path
     res = runner.invoke(
         command,
@@ -147,8 +144,7 @@ def benchmark_kfactor_cli(test_files, tmp_path):
             str(kfolder),
             str(fake_yaml_path),
             str(target_path),
-            max_as,
-            "False",
+            ordr_to_update,
         ],
     )
-    assert "The number of bins match the lenght of the k-factor" in res.output
+    assert "The number of bins match the length of the k-factor" in res.output

benchmarks/bench_kfactor.py

@@ -7,13 +7,13 @@
 
 def benchmark_kfactor_inclusion(test_files, tmp_path, test_pdf, lhapdf_path):
     fake_yaml_path = test_files / "data" / "yamldb" / "ATLAS_TTB_FAKE.yaml"
-    max_as = 3
+    pto_to_update = 3  # here we want to update NNLO
     pdf_name = "NNPDF40_nnlo_as_01180"
     kfactor.compute_k_factor_grid(
         test_files / "data" / "grids" / "400",
         test_files / "data" / "kfactors",
         fake_yaml_path,
-        max_as,
+        pto_to_update,
         target_folder=tmp_path,
     )
     pluskfactor_grid_path = tmp_path / "ATLAS_TTB_8TEV_LJ_TRAP.pineappl.lz4"

docs/source/theory/kfactors.rst

@@ -4,8 +4,16 @@ K-Factors
 Another useful tool that `pineko` includes is ``pineko kfactor`` which allows the embedding of a kfactor
 as a proper order in a grid. The usage is the following::
 
-  pineko kfactor GRIDS_FOLDER KFACTOR_FOLDER YAMLDB_PATH TARGET_FOLDER MAX_AS ORDER_EXISTS
+  pineko kfactor GRIDS_FOLDER KFACTOR_FOLDER YAMLDB_FILE TARGET_FOLDER PTO_TO_UPDATE [--order_exists]
 
 where ``GRIDS_FOLDER`` is the folder containing the grids to update, ``KFACTOR_FOLDER`` is the folder
-containing the kfactor files and ``YAMLDB_PATH`` is the path to the yamldb file of the requested dataset.
+containing the kfactor files and ``YAMLDB_FILE`` is the path to the yamldb file of the requested dataset.
 The other inputs have already been described in the previous section.
+``PTO_TO_UPDATE`` is the :math:`\alpha_s` perturbative order to update or create, with the convention that
+``LO=1``, ``NLO=2`` and so on, irrespectively to the powers of alpha_s.
+Note that only pure QCD kfactors are taken into account.
+If the flag ``order_exists`` is passed the kfactor is applied to the specified perturbative order.
+
+For example to add the NNLO in a grid containing at most NLO one has to select ``PTO_TO_UPDATE=2``;
+nn the other hand to reweight the NNLO present in a grid with a kfactor,
+one should do ``PTO_TO_UPDATE=2 --order_exists``.

pyproject.toml

@@ -11,6 +11,8 @@ authors = [
   "Alessandro Candido <[email protected]>",
   "Andrea Barontini <[email protected]>",
   "Felix Hekhorn <[email protected]>",
+  "Giacomo Magni <[email protected]>",
+  "Roy Stegeman <[email protected]>",
 ]
 classifiers = [
   "Programming Language :: Python",
@@ -25,7 +27,7 @@ packages = [{ include = "pineko", from = "src" }]
 [tool.poetry.dependencies]
 python = ">=3.8,<3.12"
 eko = "^0.14.0"
-pineappl = "^0.6.2"
+pineappl = "^0.6.3"
 PyYAML = "^6.0"
 numpy = "^1.21.0"
 pandas = "^1.4.1"

src/pineko/check.py

@@ -88,7 +88,7 @@ def check_grid_and_eko_compatible(pineappl_grid, operators, xif, max_as, max_al)
     xif : float
         factorization scale variation
     max_as: int
-        max order of alpa_s
+        max order of alpha_s
     max_al: int
         max order of alpha
 

src/pineko/cli/kfactor.py

@@ -11,28 +11,28 @@
 @command.command("kfactor")
 @click.argument("grids_folder", type=click.Path(exists=True))
 @click.argument("kfactor_folder", type=click.Path(exists=True))
-@click.argument("yamldb_path", type=click.Path(exists=True))
+@click.argument("yamldb_file", type=click.Path(exists=True))
 @click.argument("target_folder", type=click.Path(exists=True))
-@click.argument("max_as", type=int)
-@click.argument("order_exists", type=bool)
+@click.argument("pto_to_update", type=int)
+@click.option("--order_exists", is_flag=True, help="Owerwrite an existing order.")
 def k_factor_inclusion(
     grids_folder,
     kfactor_folder,
-    yamldb_path,
+    yamldb_file,
     target_folder,
-    max_as,
+    pto_to_update,
     order_exists,
 ):
     """Construct new grid with k_factor included."""
     grids_folder = pathlib.Path(grids_folder)
     kfactor_folder = pathlib.Path(kfactor_folder)
-    yamldb_path = pathlib.Path(yamldb_path)
+    yamldb_file = pathlib.Path(yamldb_file)
     target_folder = pathlib.Path(target_folder)
     kfactor.compute_k_factor_grid(
         grids_folder,
         kfactor_folder,
-        yamldb_path,
-        max_as,
+        yamldb_file,
+        pto_to_update,
         target_folder=target_folder,
         order_exists=order_exists,
     )