TaskDefinition

class ase2sprkkr.input_parameters.task_definition.TaskDefinition(input_parameters_definition_name, *, name=None, executable='kkrscf', mpi=True, experimental=False, output_reader_name=None, output_reader=None, input_files=(), output_files=(), cache_files=())[source]

Immutable declarative metadata identifying one SPR-KKR task.

Convenience methods delegate task-bound operations to their owning service registries; resolution and parsing policy does not live in this value object.

Class hierarchy

Inheritance diagram of ase2sprkkr.input_parameters.task_definition.TaskDefinition


Constructor

Parameters:
  • input_parameters_definition_name (str)

  • name (str)

  • executable (str)

  • mpi (bool)

  • experimental (bool)

  • output_reader_name (str | None)

  • output_reader (Optional[str])

  • input_files (Tuple[kkrunner.files.task_file.TaskFile, ...])

  • output_files (Tuple[kkrunner.files.task_file.TaskFile, ...])

  • cache_files (Tuple[kkrunner.files.task_file.TaskFile, ...])

__init__(input_parameters_definition_name, *, name=None, executable='kkrscf', mpi=True, experimental=False, output_reader_name=None, output_reader=None, input_files=(), output_files=(), cache_files=())[source]
Parameters:
  • input_parameters_definition_name (str)

  • name (str | None)

  • executable (str)

  • mpi (bool)

  • experimental (bool)

  • output_reader_name (str | None)

  • output_reader (str | None)

  • input_files (Iterable[str | os.PathLike[str] | Callable[[object], str | os.PathLike[str] | None]])

  • output_files (Iterable[str | os.PathLike[str] | Callable[[object], str | os.PathLike[str] | None]])

  • cache_files (Iterable[str | os.PathLike[str] | Callable[[object], str | os.PathLike[str] | None]])

Return type:

None

input_parameters_definition_name: str
name: str
executable: str
mpi: bool
experimental: bool
output_reader_name: str | None
input_files: Tuple[kkrunner.files.task_file.TaskFile, ...]
output_files: Tuple[kkrunner.files.task_file.TaskFile, ...]
cache_files: Tuple[kkrunner.files.task_file.TaskFile, ...]
output_reader(input_parameters=None, calculator=None, print_info=False, directory=None)[source]

Create this task’s output reader through the reader registry.

read_output_from_file(filename, *, input_parameters=None, calculator=None, directory=None)[source]

Read a completed output file through the task’s registered reader.