_images/logo.png

TensorHEOM Documentation

Version: 0.8.0 | License: BSD 3-Clause | GitHub

TensorHEOM is a Python package for simulating quantum circuits in non-Markovian environments using free-pole hierarchical equations of motion (FP-HEOM) combined with tensor-train (TT) compression. It is designed for superconducting-qubit simulations and connects circuit-level Qiskit input with microscopic open-system dynamics.

_images/overview.png

Key Features

  • Non-Markovian open-system dynamics via free-pole HEOM (FP-HEOM)

  • Tensor-train (MPS/MPO) compression for efficient multi-qubit simulations

  • Native Qiskit integration: transpile and simulate arbitrary quantum circuits

  • Physical unit interface: specify temperatures in mK, relaxation times T1 in µs, frequencies in GHz

  • Bath decomposition via AAA algorithm (baryrat) for arbitrary spectral densities

  • Built-in analysis tools: fidelity, concurrence, logarithmic negativity

  • HPC support: submit and retrieve jobs on SLURM clusters via SSH

  • Graphical user interface for interactive exploration

Quick Install

pip install ttheom

For a full installation guide including editable installs and platform-specific instructions see Installation Guide.

Minimal Example

from qiskit import QuantumCircuit
from ttheom import calcTimeEvo

qc = QuantumCircuit(1)
qc.h(0)

# expected runtime: 1 min
calcTimeEvo(
   fileName="result",
   qc=qc,
   numQ=1,
   freqQ=[5.0],          # GHz
   rhoIni=[[1,0],[0,0]],
   gateTime=[0.16],      # ns
   idlingTime=0.01,       # ns
   T=30,                 # mK
   T1=32,                # µs
   omegaC=20,
   exp=1/8,
   tol=1e-6,
   dtFB=0.1,             # ps
   depth=[1],
   bondDim=5,
   strideTime=0.01,       # ns
)

See Quickstart for a step-by-step walkthrough with explanation of all parameters.

Indices and Tables