Tierkreis documentation

Tierkreis [ˈtiːɐ̯ˌkʁaɪ̯s] is an HPC native workflow management system (WMS) for asynchronous hybrid jobs. Tierkreis combines task-based workers with context dependent execution on various storage implementations.

WMS	Multi-Language	Multi-Executor	HPC-Support	Visualization	Repeat until convergence	Proprietary Workers
tierkreis	✔	✔	✔	✔	✔	✔

Quick Start

To get up to speed with tierkreis we recommend the Beginners Tutorial. It will guide you through the core concepts of Tierkreis, how to construct graphs, define workers, and execute them. For more advanced topics see the specific contents below.

Contents

• Installation
• Beginners’ Tutorial
  • Before you begin
    • Setting up prepackaged workers
  • The Default Project

User guide

• Core Concepts in Tierkreis
  • Program model
  • Execution model
• Visualization
  • Running the visualizer
  • Usage
• Logging and Errors
  • Logging
  • Error Handling
  • Debug execution information
  • Visualizer
• TKR: Tierkreis CLI Tool
  • Overview
  • tkr init
  • tkr run
  • tkr vis
• Graphs
  • Types of nodes
  • Node Metadata
• Workers
  • Generating workers from the cli
  • Worker code
  • Using worker tasks
  • Running Workers
  • Prepackaged workers
• Executors
  • The worker contract
  • Worker Registries
  • Existing executors
  • Combining Executors
  • Writing your own executor
• Advanced Examples
  • Building the examples

API Reference

• API Reference
  • tierkreis
  • aer_worker
  • ibmq_worker.tkr_ibmq_worker_impl.impl
  • nexus_worker
  • pytket_worker.tkr_pytket_worker_impl.impl
  • quantinuum_worker.tkr_quantinuum_worker_impl.impl
  • qulacs_worker