Skip to content

qlroms.utils — around the framework

Case registry, the config-driven builder, metrics, diagnosis (and its figures), shared plotting helpers, paths and I/O.

At a glance

Module One-liner
config Readable names for the standard test cases (CASES, get_case, case_module), read live from each module's TEST_CASES.
builder Config-driven builds: YAML → FOM + trajectory + fitted qlROM + JSON summary (python -m qlroms.utils.builder).
metrics Trajectory-level errors and prediction horizons against the FOM.
diagnosis Local vs global (K = 1) checks, (K, r) sweeps, BIC for the chart count, switching fidelity.
diagnosis_plots The figures for those diagnostics.
plots Shared plotting helpers of the tutorials and scripts (field images, snapshot grids, coordinates, error curves, PDF helpers).
paths Where trajectories, models, meshes and snapshots live (data_dir(), the PINBALL_* locations; paths_local.py overrides) and mmap_npz, the memory-mapped mirror for big npz bundles.