Paths Class Reference

Where the active dataset lives, and where its output goes. More...

#include <Paths.hpp>

Static Public Member Functions
static TString	DatasetDir ()
	Absolute path to the active dataset directory, analysis/<iso>.
static TString	DatasetName ()
	The dataset's isotope name, e.g.
static TString	ResultsDir ()
	Absolute path to the directory receiving generated output.
static void	PrintLogo ()
	Print the project wordmark.

Detailed Description

Where the active dataset lives, and where its output goes.

The two are deliberately different kinds of value. The dataset directory is baked in at build time, because a binary belongs to exactly one dataset. The results directory is read at run time, because where processed output lands is a per-machine deployment choice that should be redirectable without a rebuild.

Definition at line 19 of file Paths.hpp.

Member Function Documentation

DatasetDir()

TString Paths::DatasetDir ( )

static

Absolute path to the active dataset directory, analysis/<iso>.

Read from MUSIC_DATASET_DIR, baked in at build time by the Makefile.

Returns

The dataset directory, without a trailing slash.

Warning

Fatally exits the process if the variable is unset. A binary with no dataset has nothing to operate on, and continuing would write output to an arbitrary location.

Note

Prints the tooling banner on first call, once per process.

Definition at line 60 of file Paths.cpp.

Referenced by RemixSim::ControlDir(), ResultsDir(), CalibrateBeam::Run(), Pipeline::Run(), BeamEnergies::SimPath(), RemixSim::SimRootPath(), and WriteEresTomlRaw().

DatasetName()

TString Paths::DatasetName ( )

static

The dataset's isotope name, e.g.

"37Cl".

Returns

The name from the build-time MUSIC_DATASET_NAME.

Definition at line 22 of file Paths.cpp.

Referenced by RemixSim::TagFromControlFile(), and RemixSim::TracesName().

PrintLogo()

void Paths::PrintLogo ( )

static

Print the project wordmark.

Public so it can run ahead of the lazy banner that DatasetDir() prints, so that a log opens with the project name rather than with a GPU probe.

Definition at line 31 of file Paths.cpp.

Referenced by Pipeline::Run().

ResultsDir()

TString Paths::ResultsDir ( )

static

Absolute path to the directory receiving generated output.

Covers root_files and plots. Read at run time from MUSIC_RESULTS_DIR, falling back to DatasetDir() when unset — so the default writes output in-repo.

Returns

The results directory, without a trailing slash.

Note

Set MUSIC_RESULTS_DIR to send output to a scratch drive without rebuilding. Running from the dev shell points it back at the in-repo dataset directory, which is writable.

Definition at line 24 of file Paths.cpp.

Referenced by RegionCutStore::Dir(), main(), TagEfficiencyStore::Path(), CalibrateBeam::Run(), Pipeline::Run(), and StripSumScatter::Run().

---

The documentation for this class was generated from the following files:

• tooling/include/Paths.hpp
• tooling/src/Paths.cpp