API reference
The root package provides backend-independent entry points for ordinary runs.
Choose executors from kkrunner.backends or kkrunner.remote; projects,
file manifests and advanced run contracts have their own public subpackages.
These import paths are independent of the modules implementing each type.
Common entry points
|
Command, files and launch intent handed to an execution backend. |
|
Raw execution facts available before task-specific interpretation. |
|
Persist public run lifecycle without task-specific knowledge. |
|
Run history stored as date-sharded durable JSON files. |
|
Single authoritative lifecycle state of one calculation run. |
|
One task file declaration, or its resolved path with retained metadata. |
Execution is complete, but this observer did not perform required processing. |
Execution contracts and durable records
|
Portable launch and staging parameters for one concrete run. |
|
Portable MPI launch semantics independent of the execution host. |
MPI autodetection was requested, but no MPI launcher was found. |
|
|
Backend status facts; the client owns durable RunRecord state. |
|
Phase in which a run entered |
|
One concrete calculation run. |
|
Raw execution plus facts consumed by persistent orchestration. |
|
A persistent observer with explicit start, refresh and detach support. |
|
Execution backend. |
|
Caller-owned runner that persists the public lifecycle directly. |
|
Single durable identity, file manifest and lifecycle of one calculation. |
|
A persisted run record cannot be decoded or validated. |
|
A persistent run would duplicate an active calculation namespace. |
Restored contents differ from a run's captured SHA-256 digest. |
|
|
Backend identity plus the directory in which the job executes. |
|
Local working directory and its optional target-side counterpart. |
Declared files and identity
|
Location of one file, with no assumptions about its content. |
|
Cache identity and its pre-execution remote signature. |
|
Resolved mapping and transfer policy of this run's file manifest. |
|
All paths and cache baselines required for transfer and reconnect. |
|
Policy controlling transfers between local and remote workspaces. |
|
Availability of a declared local artifact. |
|
Metadata identity of one filesystem object at one point in time. |
|
Relationship between a captured file version and its path on disk now. |
|
A path together with cheap metadata and authoritative content identity. |
A stable content identity could not be captured for an existing file. |
Execution backends
Create raw runners executed as local subprocesses. |
|
|
Execute calculations through a PSI/J backend such as Slurm or PBS. |
|
Identity of a reusable execution backend. |
Process-local cache of reusable execution backends. |
|
Return the process-wide pool used by ordinary calculations. |
Remote execution and transport
|
Reusable remote endpoint with client-owned lifecycle state. |
Run commands and move files on one target machine. |
|
|
A running command with independently readable output streams. |
Transport backed by asyncio subprocesses and the local filesystem. |
|
|
Transport using the system |
Projects
|
One immutable project snapshot. |
|
Persist and publish generation-checked project JSON documents. |
Base error for persistent project metadata. |
|
|
A project changed after the caller loaded it. |
A project cannot be deleted while its hierarchy role requires it. |
|
|
Track a run only when it belongs to an existing project. |
Return the KKRunner state directory containing project JSON files. |
Backend implementation interfaces
These modules expose lower-level runner implementations and resource ownership helpers for backend authors. They are not re-exported by the public facades.
|
One local subprocess execution. |
|
One raw job managed by a PSI/J executor. |
|
Client-side raw execution identified by an opaque backend ID. |
|
Convert a raw execution outcome into the caller-visible result. |
|
Closable resources whose ownership is transferred to a calculation run. |
|
Runner proxy owning resources and the public submit/cancel boundary. |