Skip to main content

License GitHub Workflow Status Code Style: black


TensorHEOM

Authors: Kiyoto Nakamura, Dennis Herb

TensorHEOM is a Python package for simulating quantum circuits in non-Markovian environments using free-pole hierarchical equations of motion (FP-HEOM) and tensor-train (TT) compression.

The package is designed for superconducting-qubit simulations and connects circuit-level Qiskit input with microscopic open-system dynamics.

Installation

Install TensorHEOM from PyPI with

pip install ttheom

Basic usage

A typical workflow is:

  1. Define a Qiskit quantum circuit.
  2. Specify system, bath, and numerical parameters.
  3. Run the TensorHEOM simulation.
  4. Analyze the reduced density matrix, fidelity, and entanglement measures.
from qiskit import QuantumCircuit
from ttheom import *

# Set system parameters
system_kwargs = {
    "numQ": 2,
    "freqQ": [5, 5], # GHz
    "rhoIni": [
        [1, 0, 0, 0],
        [0, 0, 0, 0],
        [0, 0, 0, 0],
        [0, 0, 0, 0],
    ],
    "gateTime": [16, 16, 50], # ns
    "idlingTime": 1, # ns
} 

omegaQmax, rho = prepareSystemArgs(**system_kwargs)

# Define input circuit
qc = QuantumCircuit(2)
qc.h(0)
qc.cx(0, 1)

system_kwargs["qc"] = qc

# Set bath parameters
bath_kwargs = {    
    "T": 30, # mK
    "T1": 32, # us
    "omegaC": 20,
    "exp": 1/8,
    "tol": 1e-4,
}
bathParams = prepareBathArgs(rho, omegaQmax, **bath_kwargs)

# AAA decomposition
z, d = getBathParams(bathParams[0])

# Set simulation parameters
simulation_kwargs= {
    "dtFB": 3.0, # ps
    "depth": [1, 1],
    "bondDim": 5,
    "strideTime": 0.1, # ns
    "useRFPlus": False,
    "isRK13": False,
}

# Run the calculation 
kwargs = {**system_kwargs, **bath_kwargs, **simulation_kwargs}
kwargs["directory"] = "results"
kwargs["fileName"] = "package_test"
calcTimeEvo(**kwargs) 

Graphical interface

TensorHEOM also provides a graphical user interface:

from ttheom import TensorHeomApp

TensorHeomApp().mainloop()

Documentation and examples

Example scripts and workflows are provided in the repository and in the accompanying paper.

References

Recent papers from our group:

License

TensorHEOM is distributed under the BSD 3-Clause License.

Support

For questions or support, please contact Dennis Herb at dennis.herb@uni-ulm.de.

Metadata

Release files for ttheom 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ttheom 0.1.0
File Size Uploaded Provenance
ttheom-0.1.0.tar.gz 1.0 MB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ttheom 0.1.0
File Interpreter ABI Platform
ttheom-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 2.1 MB

Release files / ttheom-0.1.0.tar.gz

Download URL ttheom-0.1.0.tar.gz
Size 1.0 MB
Tags Source
SHA-256 checksum
How to use checksums
4322cfa9bcaf19bc9ed6267b035f98f5eeef73762669bb35249e6e113403cc93
BLAKE2b-256 checksum
How to use checksums
696840aa0319289c5225e9c645f21ce45c8b1bdcb72ddd4fec7e22f58ed28342
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.9

Release files / ttheom-0.1.0-py3-none-any.whl

Download URL ttheom-0.1.0-py3-none-any.whl
Size 1.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
aedcd80c62a9853ae86bd679c09754434c2f9492608b7cf31eb23d7c4c2f3020
BLAKE2b-256 checksum
How to use checksums
23ac4aaa1cd688b03dce63207b57d32175de4510456806c94a00eae0ccc92672
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.9

Security for ttheom 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page