Feat: Event rate CI

.github/workflows/CDImage.yml

@@ -1,4 +1,3 @@
----
 # Update MaCh3 container image registry with newest updates
 name: Image CD
 
@@ -66,4 +65,4 @@ jobs:
           package-name: 'mach3'
           package-type: 'container'
           min-versions-to-keep: 5
-          delete-only-untagged-versions: 'true'
+          delete-only-untagged-versions: 'true'

.github/workflows/CIBuild.yml

@@ -1,4 +1,3 @@
----
 # Check if MaCh3 compiles correctly
 
 name: Build CI

.github/workflows/EventRates.yml

@@ -0,0 +1,71 @@
+name: Event Rates Beam
+
+# To add additional run-time tests add (to matrix)
+# - name: <your test>
+#   test_exe: /test/<your exe>
+#   test_config: path/to/tconfiguration
+#   repo_linking_command: ln -sf /path/to/files/ (usually CAFs + splines)
+
+
+on:
+  pull_request:
+    branches: [develop]
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Beam Event Rate Validation
+            test_exe: /test/TestEventRates
+            test_config: test/test_configs/EventRates_Beam_TEST.yaml
+            repo_linking_command: | 
+              ln -s \
+              /cvmfs/dune.osgstorage.org/pnfs/fnal.gov/usr/dune/persistent/stash/MaCh3/inputs/TDR/v2/DUNE_2021_FD_splines inputs/DUNE_spline_files              
+              ln -s \
+              /cvmfs/dune.osgstorage.org/pnfs/fnal.gov/usr/dune/persistent/stash/MaCh3/inputs/TDR/v2/DUNE_2023_FD_CAFs inputs/DUNE_CAF_files
+
+
+
+    name: Run Test ${{matrix.name}}
+
+    steps:
+      # Set up CVMFS
+      - name: Set up CVMFS
+        uses: cvmfs-contrib/github-action-cvmfs@v4
+
+
+      # Checkout the repository code
+      - uses: actions/checkout@v4
+
+      - name: Log in to GitHub Container Registry
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+
+      - name: start docker container with bind mount cvmfs
+        run: |
+          docker build . \
+          --file doc/MaCh3DockerFiles/Alma9/Dockerfile \
+          --tag ghcr.io/dune/mach3:alma9test \
+          --build-arg MACH3_DUNE_VERSION=${{ github.head_ref }} \
+          --build-arg MACH3_DUNE_BUILD_ARGS="-DCUDAProb3Linear_ENABLED=ON -DMACH3_BUILD_TESTS=ON"
+
+
+      # Run event rates
+      - name: Run Event Rates
+        uses: addnab/docker-run-action@v3
+        with:
+          image: ghcr.io/dune/mach3:alma9test
+          shell: bash
+          options: -v /cvmfs:/cvmfs:shared
+          run: |    
+            ${{matrix.repo_linking_command}}
+            source ./bin/setup.MaCh3.sh
+            source ./bin/setup.NuOscillator.sh
+            source ./bin/setup.MaCh3DUNE.sh
+            .${{matrix.test_exe}} ${{matrix.test_config}}

CMakeLists.txt

@@ -243,6 +243,13 @@ add_subdirectory(splines)
 add_subdirectory(samplePDFDUNE)
 add_subdirectory(src)
 
+
+# Do we want to build our integration tests?
+if(DEFINED MACH3_BUILD_TESTS AND MACH3_BUILD_TESTS)
+  add_subdirectory(tests)
+endif()
+
+
 add_library(MaCh3DUNEAll INTERFACE)
 set_target_properties(MaCh3DUNEAll PROPERTIES EXPORT_NAME All)
 target_link_libraries(MaCh3DUNEAll INTERFACE SamplePDFDUNE splinesDUNE MaCh3DUNECompilerOptions)

configs/CovObjs/OscCov_PDG2021_v2.yaml

@@ -123,10 +123,8 @@ Systematics:
     Names:
       FancyName: baseline
       ParameterName: baseline
-
-
     DetID: 984
-    Error: -1.0
+    Error: 1.0
     FlatPrior: true
     ParameterBounds: [0, 999]
     ParameterGroup: Osc

doc/MaCh3DockerFiles/Alma9/Dockerfile

@@ -8,6 +8,7 @@ ENV MACH3_DUNE_VERSION=${MACH3_DUNE_VERSION:-develop}
 ENV MACH3_DUNE_WORK_DIR=/opt/MaCh3DUNE/
 ENV MACH3_DUNE_INSTALL_DIR=${MACH3_DUNE_WORK_DIR}/build
 
+ARG MACH3_DUNE_BUILD_ARGS
 
 RUN git clone https://github.com/DUNE/MaCh3_DUNE.git ${MACH3_DUNE_WORK_DIR}
 
@@ -17,6 +18,6 @@ RUN git checkout ${MACH3_DUNE_VERSION}
 RUN mkdir -p ${MACH3_DUNE_INSTALL_DIR}
 WORKDIR ${MACH3_DUNE_INSTALL_DIR}
 
-RUN cmake ../
+RUN cmake ../ ${MACH3_DUNE_BUILD_ARGS}
 
 RUN make -j && make install

doc/MaCh3DockerFiles/Ubuntu22.04/Dockerfile

@@ -1,6 +1,17 @@
 #To run use: docker build --secret id=tokens,src=tokens.txt -t mach3dune .
 FROM rootproject/root:6.32.02-ubuntu22.04 AS mach3_dune_build
 
+# Let's be smart and use bash...
+SHELL ["/bin/bash", "-c"]
+
+# Add a label for the author
+LABEL maintainer="The MaCh3 Collaboration"
+LABEL website="https://dune.github.io/MaCh3_DUNE/"
+LABEL compiler="GNU 11.4.0"
+LABEL root_version="v6.32.02"
+LABEL org.opencontainers.image.description="Official MaCh3 DUNE container"
+
+
 RUN apt update && apt upgrade -y
 RUN apt-get install -y nlohmann-json3-dev
 #MISC_SW

tests/CMakeLists.txt

@@ -0,0 +1,49 @@
+add_custom_target(MaCh3DUNETests)
+
+# Wet up utils lib
+set(HEADERS
+    Comparison.h
+)
+
+add_library(
+    MaCh3DuneTestUtils SHARED
+    Comparison.cpp
+)
+
+set_target_properties(MaCh3DuneTestUtils PROPERTIES
+    PUBLIC_HEADER "${HEADERS}"
+    EXPORT_NAME MaCh3DuneTestUtils
+)
+
+target_link_libraries(MaCh3DuneTestUtils PUBLIC MaCh3::All MaCh3DUNECompilerOptions)
+
+target_include_directories(MaCh3DuneTestUtils PUBLIC
+  $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/../>
+  $<INSTALL_INTERFACE:include>)
+
+  install(TARGETS MaCh3DuneTestUtils
+  EXPORT mach3dune-targets
+  LIBRARY DESTINATION lib/
+  PUBLIC_HEADER DESTINATION include/MaCh3DuneTestUtils)
+
+add_library(MACH3DUNE::MaCh3DuneTestUtils ALIAS MaCh3DuneTestUtils)
+
+
+# Now we set up test apps
+foreach(app
+    TestEventRates
+)
+
+    add_executable(${app} ${app}.cpp)
+    target_link_libraries(${app} MaCh3DUNE::All MaCh3DuneTestUtils Minuit)
+    add_dependencies(MaCh3DUNEApps ${app})
+    install(TARGETS ${app} DESTINATION test)
+
+endforeach(app)
+
+
+# Now copy remaining stuff
+install(DIRECTORY test_configs DESTINATION test)
+install(DIRECTORY test_results DESTINATION test)
+
+

tests/Comparison.cpp

@@ -0,0 +1,50 @@
+// MaCh3 spline includes
+#include "tests/Comparison.h"
+
+bool CompareTwoFiles(const std::string& File1, const std::string& File2) {
+  std::ifstream file1(File1);
+  std::ifstream file2(File2);
+
+  // Check if both files opened successfully
+  if (!file1.is_open()) {
+    MACH3LOG_ERROR("Error opening file:  {}", File1);
+    throw MaCh3Exception(__FILE__ , __LINE__ );
+  }
+  if (!file2.is_open()) {
+    MACH3LOG_ERROR("Error opening file:  {}", File2);
+    throw MaCh3Exception(__FILE__ , __LINE__ );
+  }
+
+  std::string line1, line2;
+  bool sameFiles = true;
+  int lineNumber = 1;
+
+  // Read and compare line by line
+  while (std::getline(file1, line1) && std::getline(file2, line2)) {
+    if (line1 != line2) {
+      MACH3LOG_WARN("Difference found on line {}:", lineNumber);
+      MACH3LOG_WARN("File1: {}", line1);
+      MACH3LOG_WARN("File2: {}", line2);
+      sameFiles = false;
+    }
+    ++lineNumber;
+  }
+
+  // Check if one file has extra lines
+  while (std::getline(file1, line1)) {
+    MACH3LOG_WARN("Extra line in {} on line {}: {}", File1, lineNumber, line1);
+    sameFiles = false;
+    ++lineNumber;
+  }
+  while (std::getline(file2, line2)) {
+    MACH3LOG_WARN("Extra line in {} on line {}: {}", File2, lineNumber, line2);
+    sameFiles = false;
+    ++lineNumber;
+  }
+
+  // Close files
+  file1.close();
+  file2.close();
+
+  return sameFiles;
+}

tests/Comparison.h

@@ -0,0 +1,5 @@
+#pragma once
+
+#include "manager/manager.h"
+
+bool CompareTwoFiles(const std::string& File1, const std::string& File2);

tests/TestEventRates.cpp

@@ -0,0 +1,111 @@
+#include <iostream>
+#include <chrono>
+#include <iomanip>
+#include <vector>
+#include <string>
+
+#include <TH1D.h>
+#include <THStack.h>
+#include <TStyle.h>
+#include <TCanvas.h>
+#include <TRint.h>
+#include <TLegend.h>
+#include <TColor.h>
+#include <TMath.h>
+
+#include "samplePDFDUNE/MaCh3DUNEFactory.h"
+#include "samplePDFDUNE/StructsDUNE.h"
+#include "tests/Comparison.h"
+
+
+int main(int argc, char * argv[]) {
+  MaCh3Utils::MaCh3Usage(argc, argv);
+
+  auto fitMan = std::unique_ptr<manager>(new manager(argv[1]));
+
+  bool skip_checks = false;
+
+  if (CheckNodeExists(fitMan->raw(), "General", "Tests", "SkipChecks") ){
+    skip_checks = fitMan->raw()["General"]["Tests"]["SkipChecks"].as<bool>();
+  }
+
+  //###############################################################################################################################
+  //Create samplePDFFD objects
+
+  covarianceXsec* xsec = nullptr;
+  covarianceOsc* osc = nullptr;
+
+  std::vector<samplePDFFDBase*> DUNEPdfs;
+  MakeMaCh3DuneInstance(fitMan.get(), DUNEPdfs, xsec, osc);
+
+
+  //###############################################################################################################################
+  //Perform reweight and print total integral
+  //###############################################################################################################################
+  //Make oscillation channel breakdown
+  // Initialise output file
+  std::ofstream outFile("TestNewSampleOut.txt");
+
+
+  for(auto Sample : DUNEPdfs) {
+    int nOscChannels = Sample->getNMCSamples();
+    for (int iOscChan=0;iOscChan<nOscChannels;iOscChan++) {
+      std::vector< std::vector<double> > SelectionVec;
+
+      std::vector<double> SelecChannel(3);
+      SelecChannel[0] = Sample->ReturnKinematicParameterFromString("OscChannel");
+      SelecChannel[1] = iOscChan;
+      SelecChannel[2] = iOscChan+1;
+      SelectionVec.push_back(SelecChannel);
+
+      TH1* Hist = Sample->get1DVarHist("TrueNeutrinoEnergy",SelectionVec);
+      outFile<<Sample->GetName()<<" "<<Sample->getFlavourName(iOscChan)<<" "<<Hist->Integral()<<" ";
+    }
+
+    TH1* Hist = Sample->get1DVarHist("TrueNeutrinoEnergy");
+    outFile<<Sample->GetName()<<" "<<Hist->Integral()<<" ";
+  }
+
+  //###############################################################################################################################
+  //Make interaction channel breakdown
+
+  for(auto Sample : DUNEPdfs) {
+    int nModeChannels = kMaCh3_nModes;
+    for (int iModeChan=0;iModeChan<nModeChannels;iModeChan++) {
+      std::vector< std::vector<double> > SelectionVec;
+
+      std::vector<double> SelecChannel(3);
+      SelecChannel[0] = Sample->ReturnKinematicParameterFromString("Mode");
+      SelecChannel[1] = iModeChan;
+      SelecChannel[2] = iModeChan+1;
+      SelectionVec.push_back(SelecChannel);
+
+      TH1* Hist = Sample->get1DVarHist("TrueNeutrinoEnergy",SelectionVec);
+      outFile<<Sample->GetName()<<" "<<MaCh3mode_ToDUNEString((MaCh3_Mode)iModeChan)<<" "<<Hist->Integral()<<" ";
+    }
+
+    TH1* Hist = Sample->get1DVarHist("TrueNeutrinoEnergy");
+    outFile<<Sample->GetName()<<" "<<Hist->Integral()<<" ";
+  }
+
+  // Do you want to gener
+  if(skip_checks){
+    return 0;
+  }
+
+  std::string results_file = fitMan->raw()["General"]["Tests"]["TestResultsFile"].as<std::string>();
+
+
+  // Okay now we've written we need to compare 
+  bool TheSame = CompareTwoFiles(results_file, "TestNewSampleOut.txt");
+
+  // Are we right?
+  if(!TheSame) {
+    MACH3LOG_CRITICAL("Different event rates detected");
+    throw MaCh3Exception(__FILE__ , __LINE__ );
+  } else {
+    MACH3LOG_INFO("Event rates match");
+  }
+
+  return 0;
+}