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
  • Overview: module code

All modules for which code is available

  • ttheom.bath.broadband
  • ttheom.bath.params
  • ttheom.circuit.pulse_seq
  • ttheom.circuit.transform_circ
  • ttheom.dynamics.dynamics
  • ttheom.dynamics.tdevott
  • ttheom.evaluation.concurrence
  • ttheom.evaluation.fidelity
  • ttheom.evaluation.logarithmic_negativity
  • ttheom.evaluation.plot_pulse_seq
  • ttheom.evaluation.plot_qc
  • ttheom.evaluation.plot_rdo
  • ttheom.main
  • ttheom.pulse.direct_cpl_step_varJ
  • ttheom.pulse.iswapd
  • ttheom.pulse.rxy_step
  • ttheom.pulse.set_gates
  • ttheom.pulse.u3
  • ttheom.ssh.commands
  • ttheom.ssh.connect_ssh
  • ttheom.ssh.job_control
  • ttheom.ssh.slurm
  • ttheom.tt.TTs
  • ttheom.tt.TTs1Q
  • ttheom.tt.TTs2QId
  • ttheom.tt.TTsMQChainId
  • ttheom.tt.TTsTwoLevelId
  • ttheom.utils.io_csv
  • ttheom.utils.io_qc
  • ttheom.utils.prepare

© Copyright 2026, Dennis Herb.

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