vibeqc.write_system_manifest

vibeqc.write_system_manifest(out_path, wall_seconds, basename, *, record_hostname=True, fingerprint=None)[source]

Write the per-job system manifest next to out_path.

The manifest path is out_path.with_suffix('.system') — pass either the .out file path or the bare stem; both produce the same target.

Parameters:
  • out_path (PathLike | str) – The text-output path (or stem) the calculation produced. write_system_manifest writes to the sibling .system path. The parent directory must already exist (run_job creates it).

  • wall_seconds (float) – Total job wall-clock time in seconds. Recorded in the [run] section so a reader can pair the wall-time with the host hardware.

  • basename (str) – Path stem identifying the job (e.g. "input-h2o-rhf"). Recorded as run.basename so the manifest is self- identifying without needing to read its filename.

  • record_hostname (bool) – Forwarded to system_info(). False (or VIBEQC_NO_HOSTNAME=1 in the env) writes hostname = "<redacted>".

  • fingerprint (str | None) – Optional run_fingerprint() value for this job. When passed, it is recorded as [run].fingerprint so a reader can answer “is this the same calculation?” without diffing files. None (default) omits the field — back-compatible with manifests written by v0.5.1 / v0.5.2 / v0.5.3.

Returns:

The path of the written .system file.

Return type:

pathlib.Path