feat(config): route SEvt output directory through app config

This branch refactors output directory handling so app-level JSON config can control where event
folders are written, instead of relying only on default `SEventConfig` behavior/env vars.

- Centralize runtime output path control in the application config layer.
- Make output location explicit and reproducible across binaries.
- Reduce dependence on ad-hoc env setup in test and local runs.

If `event.output_dir` is set, SEvt output folders are rooted there.

Author: plexoos

config/dev.json

@@ -25,6 +25,7 @@
 
   "event": {
     "mode": "DebugLite",
-    "maxslot": 1000000
+    "maxslot": 1000000,
+    "output_dir": "/tmp"
   }
 }

src/GPUCerenkov.cpp

@@ -12,6 +12,7 @@
 
 #include "sysrap/OPTICKS_LOG.hh"
 
+#include "config.h"
 #include "GPUCerenkov.h"
 
 #include "G4RunManager.hh"
@@ -56,7 +57,7 @@ int main(int argc, char **argv)
 
     argparse::ArgumentParser program("GPUCerenkov", "0.0.0");
 
-    string gdml_file, macro_name;
+    string gdml_file, config_name, macro_name;
     bool interactive;
 
     program.add_argument("-g", "--gdml")
@@ -65,6 +66,12 @@ int main(int argc, char **argv)
         .nargs(1)
         .store_into(gdml_file);
 
+    program.add_argument("-c", "--config")
+        .help("the name of a config file")
+        .default_value(string("dev"))
+        .nargs(1)
+        .store_into(config_name);
+
     program.add_argument("-m", "--macro")
         .help("path to G4 macro")
         .default_value(string("run.mac"))
@@ -87,6 +94,8 @@ int main(int argc, char **argv)
         exit(EXIT_FAILURE);
     }
 
+    gphox::Config cfg(config_name);
+
     // Configure Geant4
     // The physics list must be instantiated before other user actions
     G4VModularPhysicsList *physics = new FTFP_BERT;

src/GPUPhotonFileSource.cpp

@@ -13,6 +13,7 @@
 
 #include "sysrap/OPTICKS_LOG.hh"
 
+#include "config.h"
 #include "GPUPhotonFileSource.h"
 
 using namespace std;
@@ -23,7 +24,7 @@ int main(int argc, char **argv)
 
     argparse::ArgumentParser program("GPUPhotonFileSource", "0.0.0");
 
-    string gdml_file, macro_name, photon_file;
+    string gdml_file, config_name, macro_name, photon_file;
     bool interactive;
 
     program.add_argument("-g", "--gdml")
@@ -32,6 +33,12 @@ int main(int argc, char **argv)
         .nargs(1)
         .store_into(gdml_file);
 
+    program.add_argument("-c", "--config")
+        .help("the name of a config file")
+        .default_value(string("dev"))
+        .nargs(1)
+        .store_into(config_name);
+
     program.add_argument("-p", "--photons")
         .help("path to input photon text file (one photon per line: pos_x pos_y pos_z time mom_x mom_y mom_z pol_x "
               "pol_y pol_z wavelength)")
@@ -75,6 +82,8 @@ int main(int argc, char **argv)
     CLHEP::HepRandom::setTheSeed(seed);
     G4cout << "Random seed set to: " << seed << G4endl;
 
+    gphox::Config cfg(config_name);
+
     // Configure Geant4
     // The physics list must be instantiated before other user actions
     G4VModularPhysicsList *physics = new FTFP_BERT;

src/GPURaytrace.cpp

@@ -12,6 +12,7 @@
 
 #include "sysrap/OPTICKS_LOG.hh"
 
+#include "config.h"
 #include "GPURaytrace.h"
 
 #include "G4RunManager.hh"
@@ -53,7 +54,7 @@ int main(int argc, char **argv)
 
     argparse::ArgumentParser program("GPURaytrace", "0.0.0");
 
-    string gdml_file, macro_name;
+    string gdml_file, config_name, macro_name;
     bool interactive;
 
     program.add_argument("-g", "--gdml")
@@ -62,6 +63,12 @@ int main(int argc, char **argv)
         .nargs(1)
         .store_into(gdml_file);
 
+    program.add_argument("-c", "--config")
+        .help("the name of a config file")
+        .default_value(string("dev"))
+        .nargs(1)
+        .store_into(config_name);
+
     program.add_argument("-m", "--macro")
         .help("path to G4 macro")
         .default_value(string("run.mac"))
@@ -98,6 +105,8 @@ int main(int argc, char **argv)
     CLHEP::HepRandom::setTheSeed(seed);
     G4cout << "Random seed set to: " << seed << G4endl;
 
+    gphox::Config cfg(config_name);
+
     // Configure Geant4
     // The physics list must be instantiated before other user actions
     G4VModularPhysicsList *physics = new FTFP_BERT;

src/config.cpp

@@ -1,5 +1,6 @@
 #include <cstdlib>
 #include <filesystem>
+#include <fstream>
 #include <iostream>
 #include <stdexcept>
 #include <string>
@@ -28,8 +29,22 @@ bool FileExists(const std::string &path)
     return std::filesystem::exists(path, ec) && !ec;
 }
 
+std::filesystem::path DefaultOutputDir()
+{
+    return std::filesystem::current_path();
+}
+
+std::filesystem::path ReadOutputDir(const nlohmann::json& event)
+{
+    if (event.contains("output_dir"))
+        return event["output_dir"].get<std::string>();
+
+    return DefaultOutputDir();
+}
+
 Config::Config(std::string config_name) :
-  name{std::getenv("GPHOX_CONFIG") ? std::getenv("GPHOX_CONFIG") : config_name}
+  name{config_name},
+  output_dir{DefaultOutputDir()}
 {
   ReadConfig(Locate(name + ".json"));
 }
@@ -111,31 +126,36 @@ void Config::ReadConfig(std::string filepath)
     std::ifstream ifs(filepath);
     ifs >> json;
 
-    nlohmann::json torch_ = json["torch"];
-
-    torch = {
-      .gentype = OpticksGenstep_::Type(torch_["gentype"]),
-      .trackid = torch_["trackid"],
-      .matline = torch_["matline"],
-      .numphoton = torch_["numphoton"],
-      .pos = make_float3(torch_["pos"][0], torch_["pos"][1], torch_["pos"][2]),
-      .time = torch_["time"],
-      .mom = normalize(make_float3(torch_["mom"][0], torch_["mom"][1], torch_["mom"][2])),
-      .weight = torch_["weight"],
-      .pol = make_float3(torch_["pol"][0], torch_["pol"][1], torch_["pol"][2]),
-      .wavelength = torch_["wavelength"],
-      .zenith = make_float2(torch_["zenith"][0], torch_["zenith"][1]),
-      .azimuth = make_float2(torch_["azimuth"][0], torch_["azimuth"][1]),
-      .radius = torch_["radius"],
-      .distance = torch_["distance"],
-      .mode = torch_["mode"],
-      .type = storchtype::Type(torch_["type"])
-    };
+    if (json.contains("torch")) {
+      nlohmann::json torch_ = json["torch"];
+
+      torch = {
+        .gentype = OpticksGenstep_::Type(torch_["gentype"]),
+        .trackid = torch_["trackid"],
+        .matline = torch_["matline"],
+        .numphoton = torch_["numphoton"],
+        .pos = make_float3(torch_["pos"][0], torch_["pos"][1], torch_["pos"][2]),
+        .time = torch_["time"],
+        .mom = normalize(make_float3(torch_["mom"][0], torch_["mom"][1], torch_["mom"][2])),
+        .weight = torch_["weight"],
+        .pol = make_float3(torch_["pol"][0], torch_["pol"][1], torch_["pol"][2]),
+        .wavelength = torch_["wavelength"],
+        .zenith = make_float2(torch_["zenith"][0], torch_["zenith"][1]),
+        .azimuth = make_float2(torch_["azimuth"][0], torch_["azimuth"][1]),
+        .radius = torch_["radius"],
+        .distance = torch_["distance"],
+        .mode = torch_["mode"],
+        .type = storchtype::Type(torch_["type"])
+      };
+    }
 
     nlohmann::json event_ = json["event"];
 
+    output_dir = ReadOutputDir(event_);
+
     SEventConfig::SetEventMode( string(event_["mode"]).c_str() );
     SEventConfig::SetMaxSlot( event_["maxslot"] );
+    SEventConfig::SetOutFold(output_dir.string().c_str());
   }
   catch (nlohmann::json::exception& e) {
     std::string errmsg{"Failed reading config parameters from " + filepath + "\n" + e.what()};

src/config.h

@@ -24,6 +24,9 @@ class Config
   /// A unique name associated with this Config
   std::string name;
 
+  /// Base directory for event output folders.
+  std::filesystem::path output_dir;
+
   storch torch;
 
  private:

sysrap/SEvt.cc

@@ -4231,6 +4231,7 @@ SEvt::DefaultBase
 
 If argument is defined it is used, otherwise::
 
+   SEventConfig::OutFold() when explicitly overridden, otherwise
    $TMP/GEOM/$GEOM/$ExecutableName
 
 Note that when Opticks is used from python the OPTICKS_SCRIPT
@@ -4242,11 +4243,26 @@ ExecutableName of "python3.11" or whatever.
 const char* SEvt::DefaultBase(const char* base_) // static
 {
     const char* base = nullptr ;
+    const char* outfold = SEventConfig::OutFold();
+    bool use_outfold =
+        base_ == nullptr &&
+        outfold != nullptr &&
+        strcmp(outfold, SEventConfig::_OutFoldDefault) != 0;
+
     int64_t mode_save = SEventConfig::ModeSave();
-    if( mode_save == 0 )
+    if (base_ != nullptr)
+    {
+        base = base_;
+    }
+    else if (use_outfold)
+    {
+        // Honor explicit OutFold overrides from config/env for SEvt event folders.
+        base = outfold;
+    }
+    else if (mode_save == 0)
     {
         // controlled dir approach : good for campaigns
-        base = base_ ? base_ : spath::DefaultOutputDir() ;
+        base = spath::DefaultOutputDir();
     }
     else if( mode_save == 1 )
     {
@@ -4462,8 +4478,8 @@ or the directory argument provided.
 
 The FALLBACK_DIR which is used for the SEvt::DefaultDir is obtained from SEventConfig::OutFold
 which is normally "$DefaultOutputDir" $TMP/GEOM/$GEOM/ExecutableName
-This can be overriden using SEventConfig::SetOutFold or by setting the
-envvar OPTICKS_OUT_FOLD.
+This can be overridden using SEventConfig::SetOutFold or by setting the
+envvar OPTICKS_OUT_FOLD, which are now honored directly by SEvt::DefaultBase.
 
 It is normally much easier to use the default of "$DefaultOutputDir" as this
 takes care of lots of the bookkeeping automatically.

tests/compare_ab.py

@@ -1,5 +1,7 @@
+import argparse
 import numpy as np
 
+from pathlib import Path
 from optiphy.geant4_version import detect_geant4_version, geant4_series
 
 
@@ -13,11 +15,20 @@ def expected_diff_for_version(version):
     return EXPECTED_DIFF[geant4_series(version)]
 
 
+parser = argparse.ArgumentParser()
+parser.add_argument(
+    "--base",
+    default="/tmp",
+    help="directory containing the ALL... event folders",
+)
+args = parser.parse_args()
+
+base = Path(args.base)
 geant4_version = detect_geant4_version()
 expected_diff = expected_diff_for_version(geant4_version)
 
-a = np.load("/tmp/fakeuser/opticks/GEOM/fakegeom/simg4ox/ALL0_no_opticks_event_name/A000/record.npy")
-b = np.load("/tmp/fakeuser/opticks/GEOM/fakegeom/simg4ox/ALL0_no_opticks_event_name/B000/f000/record.npy")
+a = np.load(base / "ALL0_no_opticks_event_name/A000/record.npy")
+b = np.load(base / "ALL0_no_opticks_event_name/B000/f000/record.npy")
 
 print(a.shape)
 print(b.shape)

tests/test_GPUPhotonFileSource.sh

@@ -31,7 +31,7 @@ cat > "$PHOTON_FILE" <<'EOF'
 EOF
 
 echo "Running GPUPhotonFileSource with seed $SEED ..."
-OUTPUT=$(USER=fakeuser GEOM=fakegeom GPUPhotonFileSource \
+OUTPUT=$(GPUPhotonFileSource \
     -g "$OPTICKS_HOME/tests/geom/opticks_raindrop.gdml" \
     -p "$PHOTON_FILE" \
     -m "$OPTICKS_HOME/tests/run.mac" \
@@ -99,7 +99,7 @@ cat > "$PHOTON_FILE" <<'EOF'
 EOF
 
 echo "Running GPUPhotonFileSource ..."
-OUTPUT=$(USER=fakeuser GEOM=fakegeom GPUPhotonFileSource \
+OUTPUT=$(GPUPhotonFileSource \
     -g "$OPTICKS_HOME/tests/geom/opticks_raindrop.gdml" \
     -p "$PHOTON_FILE" \
     -m "$OPTICKS_HOME/tests/run.mac" \

tests/test_GPUPhotonSource_8x8SiPM.sh

@@ -41,7 +41,7 @@ echo "=== Test: GPUPhotonSource with 8x8SiPM_w_CSI_optial_grease.gdml ==="
 echo "Config: 1000 photons inside crystal at (-8.7, -8.7, 4.0)mm, 420nm, disc r=0.5mm"
 echo "Running GPUPhotonSource with seed $SEED ..."
 
-OUTPUT=$(USER=fakeuser GEOM=fakegeom GPUPhotonSource \
+OUTPUT=$(GPUPhotonSource \
     -g "$OPTICKS_HOME/tests/geom/8x8SiPM_w_CSI_optial_grease.gdml" \
     -c 8x8SiPM_crystal \
     -m "$OPTICKS_HOME/tests/run.mac" \