SPRKKRProfile

class ase2sprkkr.sprkkr.profile.SPRKKRProfile(executable_dir=False, executable_suffix='', mpi='auto', executor='local', backend=None, host=None, local_root=None, remote_root=None, ssh_options=(), remote_command=(), remote_python=('python3',), input_sync='changed', output_sync='changed', psij_backend=None, psij_url=None, mpi_warning=True, ssh_zstd=False, filesystem_id=None, name=None)[source]

Describe how and where SPR-KKR executables are invoked.

The public/runtime profile stays flat for configuration ergonomics. Code that creates execution objects splits it into transport, backend_config, and per-run staging and MPI options internally.

Class hierarchy

Inheritance diagram of ase2sprkkr.sprkkr.profile.SPRKKRProfile


Constructor

Parameters:
  • executable_dir (Any)

  • executable_suffix (Any)

  • mpi (Any)

  • executor (str)

  • backend (str | None)

  • host (Any)

  • local_root (Any)

  • remote_root (Any)

  • ssh_options (Any)

  • remote_command (Any)

  • remote_python (Any)

  • input_sync (str)

  • output_sync (str)

  • psij_backend (Any)

  • psij_url (Any)

  • mpi_warning (bool)

  • ssh_zstd (bool)

  • filesystem_id (str | None)

  • name (str | None)

__init__(executable_dir=False, executable_suffix='', mpi='auto', executor='local', backend=None, host=None, local_root=None, remote_root=None, ssh_options=(), remote_command=(), remote_python=('python3',), input_sync='changed', output_sync='changed', psij_backend=None, psij_url=None, mpi_warning=True, ssh_zstd=False, filesystem_id=None, name=None)
Parameters:
  • executable_dir (Any)

  • executable_suffix (Any)

  • mpi (Any)

  • executor (str)

  • backend (str | None)

  • host (Any)

  • local_root (Any)

  • remote_root (Any)

  • ssh_options (Any)

  • remote_command (Any)

  • remote_python (Any)

  • input_sync (str)

  • output_sync (str)

  • psij_backend (Any)

  • psij_url (Any)

  • mpi_warning (bool)

  • ssh_zstd (bool)

  • filesystem_id (str | None)

  • name (str | None)

Return type:

None

executable_dir: Any = False
executable_suffix: Any = ''
mpi: Any = 'auto'
executor: str = 'local'
backend: str | None = None
host: Any = None
local_root: Any = None
remote_root: Any = None
ssh_options: Any = ()
remote_command: Any = ()
remote_python: Any = ('python3',)
input_sync: str = 'changed'
output_sync: str = 'changed'
psij_backend: Any = None
psij_url: Any = None
mpi_warning: bool = True
ssh_zstd: bool = False
filesystem_id: str | None = None
name: str | None = None
property transport

Client connection, independent of the selected execution backend.

property backend_config

Backend identity is separate from the client transport and staging.

property launch_parameters
with_overrides(**overrides)[source]
create_execution(executable, input_file, output_file, directory, *, error_file=None, input_files=(), output_files=(), cache_files=(), mpi_supported=False, gdb=False)[source]

Create the concrete execution specification for one run.