Deborah.Esther.PathConfigBuilderEsther

Deborah.Esther.PathConfigBuilderEsther.EstherPathConfigType
struct EstherPathConfig

Configuration container for all file and directory paths used in the Deborah.Esther pipeline.

Fields

  • path::String: Base path to the ensemble directory.
  • traceM_names::NTuple{4, String}: Names of the four trace files ($\text{Tr} \, M^{-n} \; (n=1,2,3,4)$) with model tags.
  • decoded_inputs::NTuple{4, String}: Original trace identifier strings (e.g., plaq.dat_rect.dat).
  • encoded_inputs::NTuple{4, String}: Abbreviated trace identifier strings (e.g., Plaq-Rect).
  • data_Y::NTuple{4, String}: Observable names ($Y$) used for each trace model.
  • trace_dirs::NTuple{4, String}: Directories where trace files are located.
  • tr_tex_dirs::NTuple{4, String}: Full paths to each trace directory including trace file name.
  • analysis_dir::String: Directory for analysis output files.
  • overall_name::String: Unique identifier name per job (used in output filenames).
  • my_tex_dir::String: Path to $\LaTeX$ output folder.
  • info_file::String: Path to summary .toml file storing metadata.
source
Deborah.Esther.PathConfigBuilderEsther.build_path_config_EstherFunction
build_path_config_Esther(
    data::TOMLConfigEsther.TraceDataConfig,
    abbrev::StringTranscoder.AbbreviationConfig,
    jobid::Union{Nothing, String}=nothing;
    project_root::String = "",
    subdir::String = ""
) -> EstherPathConfig

Construct all path-related configuration for a single Deborah.Esther job.

Arguments

  • data::TOMLConfigEsther.TraceDataConfig: Contains ensemble name, trace settings, and observable metadata.
  • abbrev::StringTranscoder.AbbreviationConfig: Contains abbreviation mappings for trace identifier encoding.
  • jobid::Union{Nothing, String} (optional): Optional job ID for labeling logs and outputs.
  • project_root::String (keyword, optional): If non-empty, prepends the project root directory to all generated paths.
  • subdir::String (keyword, optional): If non-empty, inserted between data.location and collection in all constructed paths.

Returns

Behavior

  • Builds standardized trace names with or without abbreviation.
  • Resolves directories for each trace ($\text{Tr} \, M^{-n} \; (n=1,2,3,4)$).
  • Constructs the output analysis directory and summary filename.
  • Uses project_root as the base path if specified.
  • If subdir is provided, it is inserted as a subfolder under data.location.
  • Removes existing info file, if present.

Notes

This function does not create or write trace data, but prepares the path structure required for downstream modules (e.g., Deborah.Esther.TraceDataLoader, Deborah.Esther.SummaryWriterEsther).

source