Skip to main content

Documentation Status License GitHub Workflow Status PyPI version Python versions


QCircuitHEOM

Authors: Kiyoto Nakamura, Dennis Herb

QCircuitHEOM 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 QCircuitHEOM from PyPI with

pip install qcheom

Basic usage

A typical workflow is:

  1. Define a Qiskit quantum circuit.
  2. Specify system, bath, and numerical parameters.
  3. Run the QCircuitHEOM simulation.
from qiskit import QuantumCircuit
from qcheom 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
)
  1. Analyze the pulse sequence, reduced density matrix, and fidelity. For multiple qubits, also analyze concurrence and logarithmic negativity.
import os
from qcheom import *

directory = os.getcwd()
fileName = 'result'

# load kwargs from QPY file 
kwargs = getKwargs(directory, fileName)

# load result from CSV file
t_list, rdo_list = getResult(directory, fileName)

# Post-processing
plotQC(**kwargs)
plotPulseSeq(**kwargs)
plotFidelity(t_list, rdo_list, **kwargs)
plotConcurrence(t_list, rdo_list, **kwargs)
plotLogNeg(t_list, rdo_list, **kwargs)
plotRDO(t_list, rdo_list, **kwargs)

Graphical interface

QCircuitHEOM also provides a graphical user interface:

from qcheom import GUI

GUI().mainloop()

Documentation

Documentation Status

The documentation is available on Read the Docs: https://tensorheom.readthedocs.io/en/latest/

References

Recent papers from our group:

License

QCircuitHEOM is distributed under the BSD 3-Clause License.

Support

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qcheom-0.1.0.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qcheom-0.1.0-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

Details for the file qcheom-0.1.0.tar.gz.

File metadata

  • Download URL: qcheom-0.1.0.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for qcheom-0.1.0.tar.gz
Algorithm Hash digest
SHA256 dcd0cf15cb061b4b31951b61a917800eedfc79188c390db9839674df2a25cf42
MD5 e711325ec580f78d36319124a5167939
BLAKE2b-256 243095295299799ad48dcce82d002fb854c7eb389d39019a7677f34ff52d9b70

See more details on using hashes here.

File details

Details for the file qcheom-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: qcheom-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for qcheom-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f4b0781735e215a638e6dda9f1152af0b0fde755d090d2761f25e6a6bee0775
MD5 f79ca6fdd83cbecec65e56d9ff68c16b
BLAKE2b-256 ce6c8ed40e60ddb0e82bda9fa4acbd2d25ae2ea712baccdd0f1c0f1ca097c2f9

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

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