Skip to content

config

config

Configuration owned by the execution providers.

ClusterConfig(root: str, work: str, log: str | None = None, data: str | None = None, checkpoints: str | None = None, results: str | None = None, objects: str | None = None, status: str | None = None, share: str | None = None, mount: str | None = None, cache_size: str | None = None, cache_dir: str | None = None, all_squash: str | None = None) dataclass

Filesystem and environment shared by a compute cluster.

DispatchConfig(mount: str | None = None, proxy: str | None = None, clusters: dict[str, ClusterConfig] = dict(), hosts: dict[str, SSHConfig | SlurmConfig | VolcanoConfig] = dict(), priority: list[str] = list(), gres_mapping: dict[str, str] = dict()) dataclass

SSH, SLURM, and Volcano inventory used to solve an execution.

The default loader reads $XDG_CONFIG_HOME/theseus/config.yaml and falls back to the legacy ~/.theseus.yaml location.

load(path: str | Path | None = None) -> Self classmethod

Load an explicit or standard dispatch YAML file.

Parameters:

Name Type Description Default
path str | Path | None

Explicit YAML path. When omitted, use the XDG path and then the legacy home-directory path.

None

Returns:

Type Description
Self

Parsed SSH, SLURM, and Volcano configuration. Unsupported host types are

Self

ignored.

Raises:

Type Description
FileNotFoundError

If no requested or standard file exists.

ValueError

If mutually exclusive top-level options are present.