Put legacy code in new crate pineappl_v0

.github/actions/cache-test-data/action.yml

@@ -10,10 +10,11 @@ runs:
       uses: actions/cache@v4
       with:
         path: test-data
-        key: test-data-v24
+        key: test-data-v30
     - name: Download test data if cache miss
       if: steps.cache.outputs.cache-hit != 'true'
       run: |
         cd maintainer
+        # TODO: if this script fails to download some files, the cache is saved nevertheless
         ./download-test-data.sh
       shell: bash

CONTRIBUTING.md

@@ -56,6 +56,11 @@ increasing the MSRV make sure to set it everywhere to the same value:
   data with `curl`. To make Github refresh the cached test data when running
   the CI, increase the integer `XX` in the line `key: test-data-vXX` by one.
 
+### Regression tests for Github Issues
+
+If you're writing a regression test for a Github Issue, name the test
+`issue_XXX`, where `XXX` is the Github Issue number.
+
 ## Git
 
 - When you commit, make sure the commit message is written properly. This

Cargo.toml

@@ -6,6 +6,7 @@ members = [
     "pineappl_cli",
     "pineappl_fastnlo",
     "pineappl_py",
+    "pineappl_v0",
     "xtask",
 ]
 default-members = [

maintainer/download-test-data.sh

@@ -21,6 +21,10 @@ files=(
     'https://data.nnpdf.science/dy_high_mass/NNPDF_DY_14TEV_BSM_AFB.pineappl.lz4'
     'https://data.nnpdf.science/pineappl/test-data/ATLASWPT11-Wplus_tot.appl'
     'https://data.nnpdf.science/pineappl/test-data/CMS_TTB_8TEV_2D_TTM_TRAP_TOT-opt.pineappl.lz4'
+    'https://data.nnpdf.science/pineappl/test-data/DYAA_0.3.0_LagrangeSubgridV1.pineappl.lz4'
+    'https://data.nnpdf.science/pineappl/test-data/DYAA_0.4.1_LagrangeSparseSubgridV1.pineappl.lz4'
+    'https://data.nnpdf.science/pineappl/test-data/DYAA_0.4.1_LagrangeSubgridV1.pineappl.lz4'
+    'https://data.nnpdf.science/pineappl/test-data/DYAA_0.4.1_LagrangeSubgridV2.pineappl.lz4'
     'https://data.nnpdf.science/pineappl/test-data/CMS_TTB_8TEV_2D_TTM_TRAP_TOT.tar'
     'https://data.nnpdf.science/pineappl/test-data/E906nlo_bin_00.pineappl.lz4'
     'https://data.nnpdf.science/pineappl/test-data/E906nlo_bin_00.tar'

maintainer/make-release.sh

@@ -70,6 +70,7 @@ for crate in . ${crates[@]}; do
         -e "s:^\(pineappl_applgrid = .*\)version = \".*\":\1version = \"=${version}\":" \
         -e "s:^\(pineappl_cli = .*\)version = \".*\":\1version = \"=${version}\":" \
         -e "s:^\(pineappl_fastnlo = .*\)version = \".*\":\1version = \"=${version}\":" \
+        -e "s:^\(pineappl_v0 = .*\)version = \".*\":\1version = \"=${version}\":" \
         ${crate}/Cargo.toml
     git add ${crate}/Cargo.toml
 done

pineappl/Cargo.toml

@@ -26,8 +26,7 @@ git-version = "0.3.5"
 itertools = "0.10.1"
 lz4_flex = "0.11.6"
 ndarray = { features = ["serde"], version = "0.15.4" }
-# TODO: opt out of default features in this crate to match line above
-pineappl-v0 = { package = "pineappl", version = "0.8.2" }
+pineappl_v0 = { path = "../pineappl_v0", version = "=1.3.3" }
 rayon = "1.5.1"
 rustc-hash = "1.1.0"
 serde = { features = ["derive"], version = "1.0.130" }

pineappl/src/v0.rs

@@ -41,10 +41,26 @@ pub fn default_interps(flexible_scale: bool, convolutions: usize) -> Vec<Interp>
 }
 
 pub fn read_uncompressed_v0(mut reader: impl BufRead) -> Result<Grid> {
+    use pineappl_v0::convolutions::Convolution;
+    use pineappl_v0::pids::PidBasis as PidBasisV0;
     use pineappl_v0::subgrid::Subgrid as _;
 
-    let grid = GridV0::read(&mut reader).map_err(|err| Error::Other(err.into()))?;
-    let convolutions = read_convolutions_from_metadata(&grid);
+    let grid = GridV0::read_uncompressed(&mut reader).map_err(|err| Error::Other(err.into()))?;
+    let convolutions: Vec<_> = grid
+        .convolutions()
+        .into_iter()
+        .map(|old_conv| match old_conv {
+            Convolution::UnpolPDF(pid) => Some(Conv::new(ConvType::UnpolPDF, pid)),
+            Convolution::PolPDF(pid) => Some(Conv::new(ConvType::PolPDF, pid)),
+            Convolution::UnpolFF(pid) => Some(Conv::new(ConvType::UnpolFF, pid)),
+            Convolution::PolFF(pid) => Some(Conv::new(ConvType::PolFF, pid)),
+            Convolution::None => None,
+        })
+        .collect();
+    let pid_basis = match grid.pid_basis() {
+        PidBasisV0::Pdg => PidBasis::Pdg,
+        PidBasisV0::Evol => PidBasis::Evol,
+    };
 
     let flexible_scale_grid = grid.subgrids().iter().any(|subgrid| {
         subgrid
@@ -128,16 +144,7 @@ pub fn read_uncompressed_v0(mut reader: impl BufRead) -> Result<Grid> {
                 )
             })
             .collect(),
-        grid.key_values()
-            .and_then(|kv| kv.get("lumi_id_types"))
-            // TODO: use PidBasis::from_str
-            .map_or(PidBasis::Pdg, |lumi_id_types| {
-                match lumi_id_types.as_str() {
-                    "pdg_mc_ids" => PidBasis::Pdg,
-                    "evol" => PidBasis::Evol,
-                    _ => panic!("unknown PID basis '{lumi_id_types}'"),
-                }
-            }),
+        pid_basis,
         convolutions.clone().into_iter().flatten().collect(),
         default_interps(
             flexible_scale_grid,
@@ -261,74 +268,3 @@ pub fn read_uncompressed_v0(mut reader: impl BufRead) -> Result<Grid> {
 
     Ok(result)
 }
-
-fn read_convolutions_from_metadata(grid: &GridV0) -> Vec<Option<Conv>> {
-    grid.key_values().map_or_else(
-        // if there isn't any metadata, we assume two unpolarized proton-PDFs are used
-        || vec![Some(Conv::new(ConvType::UnpolPDF, 2212)); 2],
-        |kv| {
-            // file format v0 only supports exactly two convolutions
-            (1..=2)
-                .map(|index| {
-                    // if there are key-value pairs `convolution_particle_1` and
-                    // `convolution_type_1` and the same with a higher index, we convert this
-                    // metadata into `Convolution`
-                    match (
-                        kv.get(&format!("convolution_particle_{index}"))
-                            .map(|s| s.parse::<i32>()),
-                        kv.get(&format!("convolution_type_{index}"))
-                            .map(String::as_str),
-                    ) {
-                        (_, Some("None")) => None,
-                        (Some(Ok(pid)), Some("UnpolPDF")) => Some(Conv::new(ConvType::UnpolPDF, pid)),
-                        (Some(Ok(pid)), Some("PolPDF")) => Some(Conv::new(ConvType::PolPDF, pid)),
-                        (Some(Ok(pid)), Some("UnpolFF")) => Some(Conv::new(ConvType::UnpolFF, pid)),
-                        (Some(Ok(pid)), Some("PolFF")) => Some(Conv::new(ConvType::PolFF, pid)),
-                        (None, None) => {
-                            // if these key-value pairs are missing use the old metadata
-                            match kv
-                                .get(&format!("initial_state_{index}"))
-                                .map(|s| s.parse::<i32>())
-                            {
-                                Some(Ok(pid)) => {
-                                    // Addresses: https://github.com/NNPDF/pineappl/issues/334
-                                    if grid.channels().is_empty() && pid == 2212 {
-                                        Some(Conv::new(ConvType::UnpolPDF, 2212))
-                                    } else {
-                                        let condition = !grid.channels().iter().all(|entry| {
-                                            entry.entry().iter().all(|&(a, b, _)|
-                                                match index {
-                                                    1 => a,
-                                                    2 => b,
-                                                    _ => unreachable!()
-                                                } == pid
-                                            )
-                                        });
-
-                                        condition.then_some(Conv::new(ConvType::UnpolPDF, pid))
-                                    }
-                                }
-                                None => Some(Conv::new(ConvType::UnpolPDF, 2212)),
-                                Some(Err(err)) => panic!(
-                                    "metadata 'initial_state_{index}' could not be parsed: {err}"
-                                ),
-                            }
-                        }
-                        (None, Some(_)) => {
-                            panic!("metadata 'convolution_type_{index}' is missing")
-                        }
-                        (Some(_), None) => {
-                            panic!("metadata 'convolution_particle_{index}' is missing")
-                        }
-                        (Some(Ok(_)), Some(type_)) => {
-                            panic!("metadata 'convolution_type_{index} = {type_}' is unknown")
-                        }
-                        (Some(Err(err)), Some(_)) => {
-                            panic!("metadata 'convolution_particle_{index}' could not be parsed: {err}")
-                        }
-                    }
-                })
-                .collect()
-        },
-    )
-}