Skip to content

base

Base class for runners.

BaseRunner dataclass 

BaseRunner(atoms: Atoms | None = None)

A base class for runners that sets up the calculation and cleans up the scratch directory.

Attributes:

  • atoms (Atoms | None) –

    Atoms object with calculator attached (or no Atoms object at all).

atoms class-attribute instance-attribute 

atoms: Atoms | None = None

cleanup 

cleanup() -> None

Perform cleanup operations on the runtime directory.

Returns:

  • None –
Source code in quacc/runners/_base.py 
49
50
51
52
53
54
55
56
57
def cleanup(self) -> None:
    """
    Perform cleanup operations on the runtime directory.

    Returns
    -------
    None
    """
    calc_cleanup(self.atoms, self.tmpdir, self.job_results_dir)

setup 

setup(
    copy_files: SourceDirectory | Copy | None = None,
) -> None

Perform setup operations on the runtime directory.

Parameters:

  • copy_files (SourceDirectory | Copy | None, default: None ) –

    Files to copy to runtime directory.

Returns:

  • None –
Source code in quacc/runners/_base.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def setup(self, copy_files: SourceDirectory | Copy | None = None) -> None:
    """
    Perform setup operations on the runtime directory.

    Parameters
    ----------
    copy_files
        Files to copy to runtime directory.

    Returns
    -------
    None
    """
    self.tmpdir, self.job_results_dir = calc_setup(
        self.atoms, copy_files=copy_files
    )