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
  • KKRunner
  • Edit on GitHub

KKRunner

KKRunner runs external programs locally, over SSH, or through a scheduler. It owns execution, declared files and durable run history. Your application owns input preparation, scientific interpretation and presentation. The core library requires only Python and platformdirs.

Start with Run a program. For restartable calculations, continue with Persistent runs and recovery; use Group runs in projects when runs belong to named projects.

User guide

  • Installation
    • Platforms
  • Run a program
  • Persistent runs and recovery
    • Result processing
    • Lifecycle and recovery decisions
    • Store and metadata contracts
  • Group runs in projects
  • Declare the files a run uses
    • Reservations
    • Transfers and captured contents
  • Choose an execution backend
    • Local and scheduler execution
    • Endpoint identity and reuse
    • Recovery capabilities
    • MPI
  • Remote execution
    • Test the protocol without SSH
  • Command-line interface
    • Manual inspection

Reference and development

  • Execution boundary and public contract
    • Reservations and filesystems
    • Completion callbacks and platform support
    • Package ownership
    • Portable remote file operations
  • API reference
    • Common entry points
    • Execution contracts and durable records
    • Declared files and identity
    • Execution backends
    • Remote execution and transport
    • Projects
    • Backend implementation interfaces
  • Development and documentation
    • Install and test a checkout
    • Build the documentation
    • Build distributable archives
    • Prereleases and publication
    • GitHub Pages
  • Index

  • Module Index

  • Search Page

Next

© Copyright .

Built with Sphinx using a theme provided by Read the Docs.