KKRunner
User guide
Installation
Run a program
Persistent runs and recovery
Group runs in projects
Declare the files a run uses
Choose an execution backend
Remote execution
Command-line interface
Reference and development
Execution boundary and public contract
API reference
Development and documentation
KKRunner
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
A
acknowledge() (kkrunner.backends.LocalExecutor method)
(kkrunner.remote.RemoteEndpointExecutor method)
acknowledge_submission() (kkrunner.backends.LocalExecutor method)
(kkrunner.remote.RemoteEndpointExecutor method)
add_output_error_listener() (kkrunner.backends.local.LocalRunner method)
(kkrunner.backends.psij.PsijRunner method)
(kkrunner.remote.runner.RemoteRunner method)
(kkrunner.runs.base.ResourceOwnedRunner method)
(kkrunner.runs.PersistentRunner method)
(kkrunner.runs.processing.PostprocessingRunner method)
(kkrunner.runs.Runner method)
add_output_listener() (kkrunner.backends.local.LocalRunner method)
(kkrunner.backends.psij.PsijRunner method)
(kkrunner.remote.runner.RemoteRunner method)
(kkrunner.runs.base.ResourceOwnedRunner method)
(kkrunner.runs.PersistentRunner method)
(kkrunner.runs.processing.PostprocessingRunner method)
(kkrunner.runs.Runner method)
all_versions (kkrunner.files.FileManifest property)
allows_serial_fallback (kkrunner.runs.MpiSpec property)
ALWAYS (kkrunner.files.FileSyncPolicy attribute)
argv (kkrunner.ExecutionSpec attribute)
ArtifactAvailabilityState (class in kkrunner.files)
artifacts (kkrunner.files.FileManifest property)
ARTIFACTS (kkrunner.runs.FailurePhase attribute)
attach() (kkrunner.backends.LocalExecutor method)
(kkrunner.backends.PsijExecutor method)
(kkrunner.remote.RemoteEndpointExecutor method)
(kkrunner.RunManager method)
(kkrunner.runs.Executor method)
attach_native_job() (kkrunner.backends.PsijExecutor method)
autodetect (kkrunner.runs.MpiSpec attribute)
availability_message (kkrunner.files.FileEntry attribute)
(kkrunner.files.FileManifest property)
availability_state (kkrunner.files.FileEntry attribute)
(kkrunner.files.FileManifest property)
AVAILABLE (kkrunner.files.ArtifactAvailabilityState attribute)
available (kkrunner.files.FileVersion property)
B
backend_id (kkrunner.backends.local.LocalRunner property)
(kkrunner.backends.psij.PsijRunner property)
(kkrunner.remote.runner.RemoteRunner property)
(kkrunner.runs.base.ResourceOwnedRunner property)
(kkrunner.runs.Execution attribute)
(kkrunner.runs.PersistentRunner property)
(kkrunner.runs.processing.PostprocessingRunner property)
(kkrunner.runs.Runner property)
(kkrunner.runs.RunStatus attribute)
BackendRunner (class in kkrunner.runs)
before (kkrunner.files.CacheEntry attribute)
C
cache_files (kkrunner.ExecutionSpec attribute)
CacheEntry (class in kkrunner.files)
caches (kkrunner.files.FileManifest attribute)
cancel() (kkrunner.backends.local.LocalRunner method)
(kkrunner.backends.psij.PsijRunner method)
(kkrunner.remote.runner.RemoteRunner method)
(kkrunner.runs.base.ResourceOwnedRunner method)
(kkrunner.runs.PersistentRunner method)
(kkrunner.runs.processing.PostprocessingRunner method)
(kkrunner.runs.Runner method)
CANCELLED (kkrunner.RunState attribute)
capture() (kkrunner.files.FileVersion class method)
captured_at (kkrunner.files.FileManifest attribute)
CHANGED (kkrunner.files.FileSyncPolicy attribute)
close() (kkrunner.backends.ExecutorPool method)
(kkrunner.runs.base.ExecutionResources method)
(kkrunner.runs.base.ResourceOwnedRunner method)
closed (kkrunner.runs.base.ExecutionResources property)
command_request() (kkrunner.ExecutionSpec method)
complete() (kkrunner.RunManager method)
CorruptRunRecord
create() (kkrunner.projects.ProjectRepository method)
create_managed_run() (kkrunner.backends.LocalExecutor method)
(kkrunner.backends.PsijExecutor method)
(kkrunner.remote.RemoteEndpointExecutor method)
(kkrunner.runs.Executor method)
create_run() (kkrunner.backends.LocalExecutor method)
(kkrunner.backends.PsijExecutor method)
(kkrunner.projects.ProjectExecutionManager method)
(kkrunner.remote.RemoteEndpointExecutor method)
(kkrunner.RunManager method)
(kkrunner.runs.Executor method)
created_at (kkrunner.runs.RunRecord attribute)
ctime_ns (kkrunner.files.FileFingerprint attribute)
CURRENT (kkrunner.files.FileState attribute)
current() (kkrunner.files.FileVersion method)
D
default_executor_pool() (in module kkrunner.backends)
default_projects_directory() (in module kkrunner.projects)
delete() (kkrunner.projects.ProjectRepository method)
device (kkrunner.files.FileFingerprint attribute)
digest (kkrunner.files.FileVersion attribute)
directory (kkrunner.ExecutionSpec attribute)
(kkrunner.projects.Project attribute)
(kkrunner.runs.Execution attribute)
discard() (kkrunner.backends.ExecutorPool method)
discard_profile() (kkrunner.backends.ExecutorPool method)
DOWNLOAD (kkrunner.runs.FailurePhase attribute)
DOWNLOADING (kkrunner.RunState attribute)
DuplicateSubmissionError
E
endpoint (kkrunner.runs.Execution attribute)
error_file (kkrunner.ExecutionOutcome attribute)
(kkrunner.ExecutionSpec attribute)
exception (kkrunner.backends.local.LocalRunner property)
(kkrunner.backends.psij.PsijRunner property)
(kkrunner.remote.runner.RemoteRunner property)
(kkrunner.runs.base.ResourceOwnedRunner property)
(kkrunner.runs.PersistentRunner property)
(kkrunner.runs.processing.PostprocessingRunner property)
(kkrunner.runs.Runner property)
Execution (class in kkrunner.runs)
execution (kkrunner.remote.runner.RemoteRunner property)
(kkrunner.runs.BackendRunner attribute)
EXECUTION (kkrunner.runs.FailurePhase attribute)
execution (kkrunner.runs.PersistentRunner property)
(kkrunner.runs.processing.PostprocessingRunner property)
(kkrunner.runs.RunRecord attribute)
(kkrunner.runs.RunStatus attribute)
ExecutionOutcome (class in kkrunner)
ExecutionResources (class in kkrunner.runs.base)
ExecutionSpec (class in kkrunner)
Executor (class in kkrunner.runs)
executor (kkrunner.backends.ExecutorEndpoint attribute)
(kkrunner.runs.processing.PostprocessingRunner property)
executor_for() (kkrunner.RunManager method)
ExecutorEndpoint (class in kkrunner.backends)
ExecutorPool (class in kkrunner.backends)
expand_files() (kkrunner.remote.LocalTransport method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
F
FAILED (kkrunner.files.ArtifactAvailabilityState attribute)
(kkrunner.RunState attribute)
failed_artifacts (kkrunner.files.FileManifest property)
failure_message (kkrunner.backends.local.LocalRunner property)
(kkrunner.backends.psij.PsijRunner property)
(kkrunner.remote.runner.RemoteRunner property)
(kkrunner.runs.BackendRunner attribute)
(kkrunner.runs.processing.PostprocessingRunner property)
failure_phase (kkrunner.backends.local.LocalRunner property)
(kkrunner.backends.psij.PsijRunner property)
(kkrunner.remote.runner.RemoteRunner property)
(kkrunner.runs.BackendRunner attribute)
(kkrunner.runs.PersistentRunner property)
(kkrunner.runs.processing.PostprocessingRunner property)
(kkrunner.runs.RunRecord attribute)
(kkrunner.runs.RunStatus attribute)
FailurePhase (class in kkrunner.runs)
fetch_result_files() (kkrunner.remote.RemoteEndpointExecutor method)
(kkrunner.runs.Executor method)
file (kkrunner.files.CacheEntry attribute)
file_digest() (kkrunner.remote.LocalTransport method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
file_signature() (kkrunner.remote.LocalTransport method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
FileEntry (class in kkrunner.files)
FileFingerprint (class in kkrunner.files)
FileManifest (class in kkrunner.files)
FileMapping (class in kkrunner.files)
files (kkrunner.backends.psij.PsijRunner property)
(kkrunner.remote.runner.RemoteRunner property)
(kkrunner.runs.BackendRunner attribute)
(kkrunner.runs.PersistentRunner property)
(kkrunner.runs.processing.PostprocessingRunner property)
(kkrunner.runs.RunRecord attribute)
(kkrunner.runs.RunStatus attribute)
FileState (class in kkrunner.files)
FileSyncPolicy (class in kkrunner.files)
filesystem_id (kkrunner.backends.ExecutorEndpoint attribute)
FileVersion (class in kkrunner.files)
FileVersionCaptureError
fingerprint (kkrunner.files.FileVersion attribute)
FINISHED (kkrunner.RunState attribute)
finished_at (kkrunner.runs.RunRecord attribute)
for_endpoint() (kkrunner.backends.ExecutorPool method)
for_profile() (kkrunner.backends.ExecutorPool method)
for_project() (kkrunner.projects.ProjectExecutionManager method)
from_mpi() (kkrunner.runs.LaunchSpec class method)
from_spec() (kkrunner.files.FileManifest class method)
from_value() (kkrunner.runs.MpiSpec class method)
G
generation (kkrunner.projects.Project attribute)
get() (kkrunner.backends.ExecutorPool method)
(kkrunner.RunStore method)
get_file() (kkrunner.remote.LocalTransport method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
get_files() (kkrunner.remote.LocalTransport method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
H
HistoricalFileMismatchError
host (kkrunner.backends.ExecutorEndpoint attribute)
I
id (kkrunner.projects.Project attribute)
(kkrunner.runs.ManagedRunner attribute)
(kkrunner.runs.PersistentRunner property)
(kkrunner.runs.RunRecord attribute)
info (kkrunner.TaskFile attribute)
initialize_availability() (kkrunner.files.FileManifest method)
inode (kkrunner.files.FileFingerprint attribute)
input_file (kkrunner.ExecutionOutcome attribute)
(kkrunner.ExecutionSpec attribute)
(kkrunner.files.FileManifest property)
input_file_is_current() (kkrunner.RunManager method)
input_files (kkrunner.ExecutionSpec attribute)
(kkrunner.files.FileManifest property)
input_sync (kkrunner.files.FileMapping attribute)
(kkrunner.runs.LaunchSpec attribute)
input_versions (kkrunner.files.FileManifest attribute)
inputs (kkrunner.files.FileManifest attribute)
is_current() (kkrunner.files.FileVersion method)
is_terminal (kkrunner.RunState property)
K
key_for_profile() (kkrunner.backends.ExecutorPool static method)
kkrunner
module
kkrunner.backends
module
kkrunner.files
module
kkrunner.projects
module
kkrunner.remote
module
kkrunner.runs
module
L
launch (kkrunner.ExecutionSpec attribute)
LAUNCH (kkrunner.runs.FailurePhase attribute)
launcher (kkrunner.runs.MpiSpec attribute)
LaunchSpec (class in kkrunner.runs)
local (kkrunner.runs.WorkingDirectory attribute)
local_path (kkrunner.files.FileEntry attribute)
local_root (kkrunner.files.FileMapping attribute)
(kkrunner.runs.LaunchSpec attribute)
LocalExecutor (class in kkrunner.backends)
LocalRunner (class in kkrunner.backends.local)
LocalTransport (class in kkrunner.remote)
M
ManagedRunner (class in kkrunner.runs)
manifests (kkrunner.files.FileManifest property)
mapping (kkrunner.files.FileManifest attribute)
message (kkrunner.runs.RunRecord attribute)
(kkrunner.runs.RunStatus attribute)
metadata (kkrunner.runs.RunRecord attribute)
MISSING (kkrunner.files.FileState attribute)
(kkrunner.files.FileSyncPolicy attribute)
mode (kkrunner.files.FileFingerprint attribute)
modify() (kkrunner.projects.Project method)
module
kkrunner
kkrunner.backends
kkrunner.files
kkrunner.projects
kkrunner.remote
kkrunner.runs
mpi (kkrunner.runs.LaunchSpec attribute)
mpi_argv (kkrunner.ExecutionSpec attribute)
mpi_uses_stdin (kkrunner.ExecutionSpec attribute)
MpiNotFoundWarning
MpiSpec (class in kkrunner.runs)
mtime_ns (kkrunner.files.FileFingerprint attribute)
N
name (kkrunner.backends.LocalExecutor attribute)
(kkrunner.backends.PsijExecutor attribute)
(kkrunner.projects.Project attribute)
(kkrunner.remote.RemoteEndpointExecutor attribute)
(kkrunner.runs.Executor attribute)
NEVER (kkrunner.files.FileSyncPolicy attribute)
NEW (kkrunner.RunState attribute)
new_record() (kkrunner.projects.ProjectExecutionManager method)
(kkrunner.RunManager method)
O
optional (kkrunner.files.FileEntry attribute)
(kkrunner.TaskFile attribute)
output_file (kkrunner.ExecutionOutcome attribute)
(kkrunner.ExecutionSpec attribute)
(kkrunner.files.FileManifest property)
output_file_is_current() (kkrunner.RunManager method)
output_files (kkrunner.ExecutionSpec attribute)
(kkrunner.files.FileManifest property)
output_sync (kkrunner.files.FileMapping attribute)
(kkrunner.runs.LaunchSpec attribute)
output_versions (kkrunner.files.FileManifest attribute)
outputs (kkrunner.files.FileManifest attribute)
OVERWRITTEN (kkrunner.files.FileState attribute)
P
parent_id (kkrunner.projects.Project attribute)
path (kkrunner.files.FileVersion attribute)
pathname (kkrunner.TaskFile attribute)
PENDING (kkrunner.files.ArtifactAvailabilityState attribute)
PersistentRunner (class in kkrunner.runs)
POSTPROCESSING (kkrunner.runs.FailurePhase attribute)
(kkrunner.RunState attribute)
PostprocessingRunner (class in kkrunner.runs.processing)
prepare_submission() (kkrunner.runs.processing.PostprocessingRunner method)
process_count (kkrunner.runs.MpiSpec attribute)
processing_attempt (kkrunner.runs.RunRecord attribute)
processing_lock() (kkrunner.RunStore method)
processing_required (kkrunner.runs.RunRecord attribute)
ProcessingPending
Project (class in kkrunner.projects)
project() (kkrunner.projects.ProjectRepository method)
project_id (kkrunner.projects.ProjectExecutionManager property)
(kkrunner.runs.RunRecord attribute)
ProjectConflictError
ProjectDeleteError
ProjectExecutionManager (class in kkrunner.projects)
ProjectRepository (class in kkrunner.projects)
ProjectRepositoryError
projects() (kkrunner.projects.ProjectRepository method)
psij_backend (kkrunner.backends.ExecutorEndpoint attribute)
psij_url (kkrunner.backends.ExecutorEndpoint attribute)
PsijExecutor (class in kkrunner.backends)
PsijRunner (class in kkrunner.backends.psij)
put_file() (kkrunner.remote.LocalTransport method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
put_files() (kkrunner.remote.LocalTransport method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
Q
query_files() (kkrunner.remote.LocalTransport method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
QUEUED (kkrunner.RunState attribute)
R
read_file() (kkrunner.remote.LocalTransport method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
reconcile_acknowledgements() (kkrunner.RunManager method)
record (kkrunner.runs.PersistentRunner property)
recover_native() (kkrunner.backends.PsijExecutor method)
recover_submission() (kkrunner.backends.LocalExecutor method)
(kkrunner.backends.PsijExecutor method)
(kkrunner.remote.RemoteEndpointExecutor method)
(kkrunner.runs.Executor method)
recover_submitting() (kkrunner.RunManager method)
refresh() (kkrunner.projects.ProjectRepository method)
(kkrunner.RunManager method)
(kkrunner.runs.ManagedRunner method)
(kkrunner.runs.PersistentRunner method)
register_executor() (kkrunner.RunManager method)
remote (kkrunner.runs.WorkingDirectory attribute)
remote_command (kkrunner.backends.ExecutorEndpoint attribute)
remote_path (kkrunner.files.FileEntry attribute)
remote_root (kkrunner.files.FileMapping attribute)
(kkrunner.runs.LaunchSpec attribute)
RemoteEndpointExecutor (class in kkrunner.remote)
RemoteRunner (class in kkrunner.remote.runner)
requested (kkrunner.runs.MpiSpec property)
required (kkrunner.runs.MpiSpec attribute)
reserve() (kkrunner.RunManager method)
resolve_mpi() (kkrunner.runs.Executor method)
resolve_submission() (kkrunner.remote.RemoteEndpointExecutor method)
ResourceOwnedRunner (class in kkrunner.runs.base)
result (kkrunner.runs.base.ResourceOwnedRunner property)
(kkrunner.runs.PersistentRunner property)
(kkrunner.runs.Runner attribute)
resume_download() (kkrunner.RunManager method)
retrieve_result_files() (kkrunner.RunManager method)
retry_postprocessing() (kkrunner.RunManager method)
return_code (kkrunner.backends.local.LocalRunner property)
(kkrunner.backends.psij.PsijRunner property)
(kkrunner.ExecutionOutcome attribute)
(kkrunner.remote.runner.RemoteRunner property)
(kkrunner.runs.BackendRunner attribute)
(kkrunner.runs.processing.PostprocessingRunner property)
(kkrunner.runs.RunRecord attribute)
(kkrunner.runs.RunStatus attribute)
returncode (kkrunner.remote.RunningCommand attribute)
run() (kkrunner.backends.local.LocalRunner method)
(kkrunner.backends.psij.PsijRunner method)
(kkrunner.remote.LocalTransport method)
(kkrunner.remote.runner.RemoteRunner method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
(kkrunner.runs.base.ResourceOwnedRunner method)
(kkrunner.runs.PersistentRunner method)
(kkrunner.runs.processing.PostprocessingRunner method)
(kkrunner.runs.Runner method)
run_async() (kkrunner.backends.local.LocalRunner method)
(kkrunner.backends.psij.PsijRunner method)
(kkrunner.remote.runner.RemoteRunner method)
(kkrunner.runs.base.ResourceOwnedRunner method)
(kkrunner.runs.PersistentRunner method)
(kkrunner.runs.processing.PostprocessingRunner method)
RunManager (class in kkrunner)
Runner (class in kkrunner.runs)
RUNNING (kkrunner.RunState attribute)
RunningCommand (class in kkrunner.remote)
RunRecord (class in kkrunner.runs)
runs() (kkrunner.RunStore method)
RunState (class in kkrunner)
RunStatus (class in kkrunner.runs)
RunStore (class in kkrunner)
S
save() (kkrunner.projects.ProjectRepository method)
(kkrunner.RunStore method)
schema_version (kkrunner.runs.RunRecord attribute)
set_manifest() (kkrunner.backends.psij.PsijRunner method)
should_transfer() (kkrunner.files.FileSyncPolicy method)
size (kkrunner.files.FileFingerprint attribute)
SKIPPED (kkrunner.files.ArtifactAvailabilityState attribute)
source_pattern (kkrunner.files.FileEntry attribute)
spec (kkrunner.runs.BackendRunner attribute)
(kkrunner.runs.processing.PostprocessingRunner property)
ssh_options (kkrunner.backends.ExecutorEndpoint attribute)
ssh_zstd (kkrunner.backends.ExecutorEndpoint attribute)
SshTransport (class in kkrunner.remote)
start() (kkrunner.backends.psij.PsijRunner method)
(kkrunner.remote.LocalTransport method)
(kkrunner.remote.runner.RemoteRunner method)
(kkrunner.remote.SshTransport method)
(kkrunner.remote.Transport method)
(kkrunner.runs.ManagedRunner method)
(kkrunner.runs.PersistentRunner method)
(kkrunner.runs.processing.PostprocessingRunner method)
state (kkrunner.backends.local.LocalRunner property)
(kkrunner.backends.psij.PsijRunner property)
(kkrunner.files.FileManifest property)
(kkrunner.remote.runner.RemoteRunner property)
(kkrunner.runs.base.ResourceOwnedRunner property)
(kkrunner.runs.PersistentRunner property)
(kkrunner.runs.processing.PostprocessingRunner property)
(kkrunner.runs.Runner property)
(kkrunner.runs.RunRecord attribute)
(kkrunner.runs.RunStatus attribute)
state() (kkrunner.files.FileVersion method)
status() (kkrunner.backends.LocalExecutor method)
(kkrunner.backends.PsijExecutor method)
(kkrunner.remote.RemoteEndpointExecutor method)
(kkrunner.runs.Executor method)
status_native() (kkrunner.backends.PsijExecutor method)
stderr (kkrunner.files.FileManifest attribute)
(kkrunner.remote.RunningCommand attribute)
stdin (kkrunner.ExecutionSpec attribute)
(kkrunner.files.FileManifest attribute)
stdout (kkrunner.files.FileManifest attribute)
(kkrunner.remote.RunningCommand attribute)
stop_observation() (kkrunner.backends.psij.PsijRunner method)
(kkrunner.remote.runner.RemoteRunner method)
(kkrunner.runs.ManagedRunner method)
(kkrunner.runs.PersistentRunner method)
(kkrunner.runs.processing.PostprocessingRunner method)
SUBMISSION (kkrunner.runs.FailurePhase attribute)
submission_directory() (kkrunner.remote.RemoteEndpointExecutor method)
(kkrunner.runs.Executor method)
submission_lock() (kkrunner.RunStore method)
submit() (kkrunner.backends.local.LocalRunner method)
(kkrunner.backends.psij.PsijRunner method)
(kkrunner.remote.runner.RemoteRunner method)
(kkrunner.runs.base.ResourceOwnedRunner method)
(kkrunner.runs.PersistentRunner method)
(kkrunner.runs.processing.PostprocessingRunner method)
(kkrunner.runs.Runner method)
submitted() (kkrunner.runs.Execution method)
SUBMITTING (kkrunner.RunState attribute)
subscribe() (kkrunner.projects.ProjectRepository method)
supports_result_file_retrieval (kkrunner.runs.Executor attribute)
T
target (kkrunner.runs.WorkingDirectory property)
TaskFile (class in kkrunner)
terminate() (kkrunner.remote.RunningCommand method)
transition() (kkrunner.RunManager method)
Transport (class in kkrunner.remote)
type (kkrunner.TaskFile attribute)
U
UNAVAILABLE (kkrunner.files.FileState attribute)
UNKNOWN (kkrunner.RunState attribute)
update() (kkrunner.RunManager method)
(kkrunner.RunStore method)
update_artifact_availability() (kkrunner.RunManager method)
updated_at (kkrunner.runs.RunRecord attribute)
W
wait() (kkrunner.backends.local.LocalRunner method)
(kkrunner.backends.psij.PsijRunner method)
(kkrunner.remote.runner.RemoteRunner method)
(kkrunner.remote.RunningCommand method)
(kkrunner.runs.base.ResourceOwnedRunner method)
(kkrunner.runs.PersistentRunner method)
(kkrunner.runs.processing.PostprocessingRunner method)
(kkrunner.runs.Runner method)
wait_status_native() (kkrunner.backends.PsijExecutor method)
warning (kkrunner.runs.MpiSpec attribute)
with_file_availability() (kkrunner.files.FileManifest method)
with_remote_stream_paths() (kkrunner.files.FileManifest method)
WorkingDirectory (class in kkrunner.runs)