Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
tierkreis documentation
tierkreis documentation
  • Installation
  • Beginners’ Tutorial
    • Lesson 1: A first workflow
    • Lesson 2: Writing Workers
    • Lesson 3: Using predefined workers
    • Lesson 4: Putting everything together
    • What Next?

User guide

  • Core Concepts in Tierkreis
  • Visualization
  • Logging and Errors
  • TKR: Tierkreis CLI Tool
  • Graphs
    • Tasks: Using Builtins
    • Inputs and Output
    • Eval: Using nested graphs
    • Loop: Iterating graphs
    • Map: Parallel computation
  • Workers
    • Complex types in Tierkreis Python workers
    • External Workers
    • Tasks with multiple outputs
    • Qiskit Aer worker
    • IBMQ Worker
    • Nexus worker
    • Pytket worker
    • Quantinuum Backend Worker
    • Qulacs worker
  • Executors
    • Shell Executors
    • Tierkreis for HPC
      • Fugaku: pjsub
  • Advanced Examples
    • Complex types, optional values
    • Leveraging parallelism through map
    • Tierkreis checkpoints; using pre build graphs
    • Errors and Debugging
    • Restarting nodes
    • Non-python workers, Multiple Executors
    • Tierkreis and HPC
    • Custom Serializers
    • QSCI

API Reference

  • API Reference
    • tierkreis
      • tierkreis.pkg
        • tierkreis.pkg.base
        • tierkreis.pkg.github
      • tierkreis.idl
        • tierkreis.idl.models
        • tierkreis.idl.parser
        • tierkreis.idl.type_symbols
        • tierkreis.idl.spec
      • tierkreis.controller
        • tierkreis.controller.storage
          • tierkreis.controller.storage.graphdata
          • tierkreis.controller.storage.debug_graph
          • tierkreis.controller.storage.filestorage
          • tierkreis.controller.storage.in_memory
          • tierkreis.controller.storage.protocol
          • tierkreis.controller.storage.adjacency
          • tierkreis.controller.storage.walk_result
          • tierkreis.controller.storage.data
          • tierkreis.controller.storage.walk
          • tierkreis.controller.storage.exceptions
        • tierkreis.controller.executor
          • tierkreis.controller.executor.hpc
            • tierkreis.controller.executor.hpc.job_spec
            • tierkreis.controller.executor.hpc.pbs
            • tierkreis.controller.executor.hpc.pjsub
            • tierkreis.controller.executor.hpc.slurm
            • tierkreis.controller.executor.hpc.hpc_executor
          • tierkreis.controller.executor.stdinout
          • tierkreis.controller.executor.shell_executor
          • tierkreis.controller.executor.multiple
          • tierkreis.controller.executor.in_memory_executor
          • tierkreis.controller.executor.check_launcher
          • tierkreis.controller.executor.uv_executor
          • tierkreis.controller.executor.protocol
          • tierkreis.controller.executor.commands
          • tierkreis.controller.executor.task_executor
          • tierkreis.controller.executor.registries
        • tierkreis.controller.data
          • tierkreis.controller.data.types
          • tierkreis.controller.data.location
          • tierkreis.controller.data.models
          • tierkreis.controller.data.core
          • tierkreis.controller.data.graph
        • tierkreis.controller.start
        • tierkreis.controller.consts
      • tierkreis.graphs
        • tierkreis.graphs.simulate
          • tierkreis.graphs.simulate.compile_simulate
        • tierkreis.graphs.nexus
          • tierkreis.graphs.nexus.submit_poll
        • tierkreis.graphs.fold
      • tierkreis.builtins
        • tierkreis.builtins.main
        • tierkreis.builtins.stubs
      • tierkreis.cli
        • tierkreis.cli.templates
        • tierkreis.cli.tkr
        • tierkreis.cli.run
        • tierkreis.cli.project
        • tierkreis.cli.run_workflow
      • tierkreis.worker
        • tierkreis.worker.storage
          • tierkreis.worker.storage.filestorage
          • tierkreis.worker.storage.in_memory
          • tierkreis.worker.storage.protocol
        • tierkreis.worker.worker
      • tierkreis.codegen
      • tierkreis.hpc
      • tierkreis.pytket_worker
      • tierkreis.labels
      • tierkreis.logger_setup
      • tierkreis.namespace
      • tierkreis.nexus_worker
      • tierkreis.builder
      • tierkreis.ibmq_worker
      • tierkreis.executor
      • tierkreis.models
      • tierkreis.qulacs_worker
      • tierkreis.aer_worker
      • tierkreis.storage
      • tierkreis.consts
      • tierkreis.quantinuum_worker
      • tierkreis.exceptions
    • 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
Back to top
View this page

tierkreis.idl.spec¶

Combinators for the Tierkreis worker IDL.

We use https://typespec.io/docs/language-basics/models/ https://typespec.io/docs/language-basics/interfaces/ as well as an extra decorator @portmapping.

Module Contents¶

Data¶

type_decl

model

method

interface

spec

API¶

type_decl = 'map(...)'¶
model = 'map(...)'¶
method = 'map(...)'¶
interface = 'map(...)'¶
spec = None¶
Next
tierkreis.controller
Previous
tierkreis.idl.type_symbols
Copyright © 2025, Quantinuum
Made with Sphinx and @pradyunsg's Furo
On this page
  • tierkreis.idl.spec
    • Module Contents
      • Data
      • API
        • type_decl
        • model
        • method
        • interface
        • spec