TensorHEOM Logo

Getting Started

  • Installation Guide
    • Installation via PyPI
      • Steps
    • Installation in editable mode via GitHub
      • Steps
    • Platform-Specific Instructions for Activation
      • Windows
      • macOS
      • Linux
    • Uninstallation
  • Quickstart
    • Installation
    • Your first simulation
    • Reading results
    • Analysing results
    • Submitting to HPC
    • Parameter reference
      • System
      • Bath
      • Numerics
    • Next steps

User Guide

  • User Guide
    • Identity Gate Sequence (single qubit)
      • Circuit
      • Running locally
      • Running on HPC
      • Reloading a saved simulation
      • Analysis
    • Bell State (two qubits)
      • Circuit
      • Running locally
      • Running on HPC
      • Analysis
    • Dynamical Decoupling (single qubit)
      • Background
      • Circuit
      • Running locally
      • Running on HPC
      • Analysis
    • GHZ State (three qubits)
      • Circuit
      • Running locally
      • Running on HPC
      • Analysis
    • Workflow overview
    • HPC workflow
    • Numerical convergence
    • Redfield+ approximation
  • Graphical User Interface (GUI)
    • Launching the GUI
    • Main window
    • Quantum circuit editor
    • Results viewer

API Reference

  • API Documentation
    • Top-level Functions
      • High-level simulation interface
      • Physical-unit helpers
      • I/O utilities
      • Bath decomposition
      • Evaluation and analysis
    • Classes & Module Functions
      • Pulse types and gate specifications
      • Tensor-train representation
      • Circuit compilation
      • Time evolution
      • HPC cluster support

About

  • Bibliography
  • Copyright and Licensing
    • License Terms for Documentation Text
    • License Terms for Source Code of TensorHEOM and Code Samples
TensorHEOM
  • API Documentation
  • Edit on GitHub

API Documentation

This chapter contains automatically generated API documentation for all public classes and functions in TensorHEOM.

The API is organised into two files:

  • Classes & Module Functions (Classes & Module Functions) — the internal building blocks: bath decomposition, pulse types, tensor-train classes, circuit compilation, dynamics, and HPC utilities.

  • Top-level Functions (Top-level Functions) — the functions you use most often, importable directly via from ttheom import ....

  • Top-level Functions
    • High-level simulation interface
      • prepareTTs
      • calcTimeEvo
      • calcTimeEvoHPC
    • Physical-unit helpers
      • prepareParams
      • prepareSystemParams
      • prepareBathParams
      • getKwargs
      • getSystemKwargs
      • getBathKwargs
    • I/O utilities
      • saveQC
      • loadQC
      • getResult
      • loadCSV
    • Bath decomposition
      • getBathParams
      • broadbandNoise
    • Evaluation and analysis
      • getFidelity
      • getConcurrence
      • getLogarithmicNegativity
      • plotPulseSeq
      • plotRDO
      • plotQC
  • Classes & Module Functions
    • Pulse types and gate specifications
      • setGates
      • getGate
      • rxyStep
      • U3Pulse
      • iSwapDPulse
      • directCplStepVarJ
    • Tensor-train representation
      • TTs
      • TTsTwoLevelId
      • TTs1Q
      • TTs2QId
      • TTsMQChainId
    • Circuit compilation
      • setPulseSeq
      • transform
      • scheduling
    • Time evolution
      • timeEvolution
      • zRightOrth
      • calcDynamics
      • outputCurrentStates
      • getRotatingRDO
    • HPC cluster support
      • submitJob
      • downloadResult
      • getClient
      • commandsForSubmission
      • getStatus
      • slurmShell
      • slurmStatus
Previous Next

© Copyright 2026, Dennis Herb.

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