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

Contents

• Installation
• Core Concepts in Tierkreis
  • Program model
    • Tasks
    • Workflows
    • Types
  • Execution model
    • Controller
    • Storage
    • Worker
    • Executor
• Getting Started
  • Project Setup
  • Tutorials for writing workflows
  • Tutorials for writing workers
    • Tierkreis Python library
    • Other Workers
  • Executors
• Visualization
  • Running the visualizer
  • Usage
    • General Functionality
    • Available Graphs
    • Node Types
    • Node Status
    • Ports & Values
    • Nested Graphs
    • Logs & Errors
• Logging and Errors
  • Logging
    • Workers
  • Error Handling
    • Static Errors
    • Runtime Errors
  • Debug execution information
  • Visualizer
• Workers
  • Complex types in Tierkreis Python workers
    • JSON style types
    • Struct using NamedTuple
    • bytes
    • DictConvertible and ListConvertible
    • Pydantic BaseModels
    • Special Python types
  • Custom serializers
  • External Workers
    • IDL
    • Parsing Inputs and Outputs
  • Hello world worker
    • Worker code
    • Generating stubs
    • Graph creation
    • Execution
  • Prepackaged workers
    • Qiskit Aer worker
    • IBMQ Worker
    • Nexus worker
    • Pytket worker
    • Quantinuum Backend Worker
    • Qulacs worker
  • Generating workers from the cli
  • Prepackaged workers
    • Qiskit Aer
    • IBMQ
    • Pytket
    • Quantinuum Nexus
    • Quantinuum Backend
    • Qulacs
• Executors
  • Shell Executors
    • Shell Executor
    • StdInOut
    • Example
  • Tierkreis for HPC
    • Job Spec
    • Examples
  • HPC specific executors
    • Fugaku pjsub
  • The worker contract
    • Controller files
    • Task, Inputs and Outputs
  • Worker Registries
  • Existing executors
  • Combining Executors
  • Writing your own executor
• Beginners tutorial
  • Graph using built-in tasks
    • Constructing the graph
    • Running the graph
  • Nested graphs using Eval
    • Graph
  • Execution
  • Graph inputs and outputs
  • Graphs
    • Single input and single output
    • Multiple inputs and multiple outputs
    • Combinations of single and multiple inputs
  • Execution
  • Iteration using Loop
    • Graphs
  • Execution
  • Parallel computation using Map
    • Example worker
    • Generating stubs
    • Writing a graph
    • Running the graph
• Examples
  • Writing tierkreis workers
    • Concepts
    • Worker Setup
  • Hello World: Tierkreis Edition
    • On tierkreis types
  • Configuring Storage and Executors, Submitting to Quantinuum, Using Predefined Workers
    • Opaque Types
  • Complex types, optional values
    • Inputs and Outputs
    • Optional Values
  • Tierkreis checkpoints; using pre build graphs
  • Leveraging parallelism through map
  • Errors and Debugging
    • Worker Errors
    • Debugging
  • Restarting nodes
  • Non-python workers, Multiple Executors
    • Preliminaries
    • Defining the interface
    • Adapting the script to the tierkreis contract
    • Building a graph using the script
    • Setting up the correct executors
    • Running simple scripts
  • Tierkreis and HPC
  • Custom Serializers
  • Hamiltonian Simulation
  • QSCI
    • The core tasks
    • Constructing the QSCI graph
  • How to use
• API Reference
  • tierkreis
    • Subpackages
    • Submodules
    • Package Contents
  • aer_worker
    • Module Contents
  • ibmq_worker
    • Module Contents
  • nexus_worker
    • Module Contents
  • pytket_worker
    • Module Contents
  • quantinuum_worker
    • Module Contents
  • qulacs_worker
    • Module Contents