tatm.config Config API Reference

class tatm.config.EnvironmentConfig(modules: List[str] | None = None, conda_env: str | None = None, venv: str | None = None, singularity_image: str | None = None)

Bases: object

Environment configuration for compute jobs.

conda_env: str | None = None

modules: List[str] | None = None

singularity_image: str | None = None

venv: str | None = None

class tatm.config.SlurmConfig(partition: str = '???', account: str | None = '???', qos: str | None = None, slurm_bin_dir: str = '/usr/bin/')

Bases: object

Cluster specific configuration for Slurm.

account: str | None = '???'

Account to charge jobs to.

partition: str = '???'

Partition to submit jobs to.

qos: str | None = None

Quality of Service to use for the job.

slurm_bin_dir: str = '/usr/bin/'

Directory containing the Slurm binaries.

class tatm.config.TatmConfig(backend: tatm.compute.job.Backend = <Backend.slurm: 'slurm'>, slurm: tatm.config.SlurmConfig = <factory>, environment: tatm.config.EnvironmentConfig = <factory>)

Bases: object

backend: Backend = 'slurm'

Backend to use for compute jobs.

environment: EnvironmentConfig

Environment configuration for compute jobs.

slurm: SlurmConfig

Slurm specific configuration.

tatm.config.load_config(config_paths: List[str] | str | None = None, overrides: List[str] | str | None = None) → TatmConfig

Load the configuration from the provided paths.

Parameters:

• config_paths – List of paths to load the configuration from.

• overrides – List of overrides to apply to the configuration

Returns:

Loaded configuration.

Return type:

TatmConfig