Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

English | 简体中文

TensorCircuit is the next generation of quantum circuit simulators with support for automatic differentiation, just-in-time compiling, hardware acceleration, and vectorized parallelism.

TensorCircuit is built on top of modern machine learning frameworks and is machine learning backend agnostic. It is specifically suitable for highly efficient simulations of quantum-classical hybrid paradigm and variational quantum algorithms.

Getting Started

Please begin with Quick Start.

For more information and introductions, please refer to helpful example scripts and full documentation. API docstrings and test cases in tests are also informative.

The following are some minimal demos.

  • Circuit manipulation:
import tensorcircuit as tc
c = tc.Circuit(2)
c.H(0)
c.CNOT(0,1)
c.rx(1, theta=0.2)
print(c.wavefunction())
print(c.expectation_ps(z=[0, 1]))
print(c.sample())
  • Runtime behavior customization:
tc.set_backend("tensorflow")
tc.set_dtype("complex128")
tc.set_contractor("greedy")
  • Automatic differentiations with jit:
def forward(theta):
    c = tc.Circuit(2)
    c.R(0, theta=theta, alpha=0.5, phi=0.8)
    return tc.backend.real(c.expectation((tc.gates.z(), [0])))

g = tc.backend.grad(forward)
g = tc.backend.jit(g)
theta = tc.array_to_tensor(1.0)
print(g(theta))

Install

The package is written in pure Python and can be obtained via pip as:

pip install tensorcircuit

We recommend you install this package with tensorflow also installed as:

pip install tensorcircuit[tensorflow]

Other optional dependencies include [torch], [jax] and [qiskit].

For the nightly build of tensorcircuit with new features, try:

pip uninstall tensorcircuit
pip install tensorcircuit-nightly

We also have Docker support.

Advantages

  • Tensor network simulation engine based

  • JIT, AD, vectorized parallelism compatible, GPU support

  • Efficiency

    • Time: 10 to 10^6+ times acceleration compared to TensorFlow Quantum, Pennylane or Qiskit

    • Space: 600+ qubits 1D VQE workflow (converged energy inaccuracy: < 1%)

  • Elegance

    • Flexibility: customized contraction, multiple ML backend/interface choices, multiple dtype precisions

    • API design: quantum for humans, less code, more power

Citing TensorCircuit

This project is released by Tencent Quantum Lab and is currently maintained by Shi-Xin Zhang with contributions from the lab and the open source community.

If this project helps in your research, please cite our software whitepaper:

TensorCircuit: a Quantum Software Framework for the NISQ Era

which is also a good introduction to the software.

Contributing

For contribution guidelines and notes, see CONTRIBUTING.

We welcome issues, PRs, and discussions from everyone, and these are all hosted on GitHub.

Research and Applications

DQAS

For the application of Differentiable Quantum Architecture Search, see applications. Reference paper: https://arxiv.org/pdf/2010.08561.pdf.

VQNHE

For the application of Variational Quantum-Neural Hybrid Eigensolver, see applications. Reference paper: https://arxiv.org/pdf/2106.05105.pdf and https://arxiv.org/pdf/2112.10380.pdf.

VQEX - MBL

For the application of VQEX on MBL phase identification, see the tutorial. Reference paper: https://arxiv.org/pdf/2111.13719.pdf.

Release files for tensorcircuit-nightly 0.6.0.dev20221213

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

Source distribution (sdist)

Source distribution for tensorcircuit-nightly 0.6.0.dev20221213
File Size Uploaded
tensorcircuit-nightly-0.6.0.dev20221213.tar.gz 248.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tensorcircuit-nightly 0.6.0.dev20221213
File Interpreter ABI Platform
tensorcircuit_nightly-0.6.0.dev20221213-py3-none-any.whl Python 3 none any Details

Total release size: 495.9 kB

Release files / tensorcircuit-nightly-0.6.0.dev20221213.tar.gz

Download URL tensorcircuit-nightly-0.6.0.dev20221213.tar.gz
Size 248.2 kB
Tags Source
SHA-256 checksum
How to use checksums
251b62cb02c8b3baed173f6698c2f1006ccf73b8a15f40d5d4033c4615bf583b
BLAKE2b-256 checksum
How to use checksums
32cc3e134e718b26f4562d52bf31e0d86a32a0755d6010dd0f8b7b65456fa4a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.1

Release files / tensorcircuit_nightly-0.6.0.dev20221213-py3-none-any.whl

Download URL tensorcircuit_nightly-0.6.0.dev20221213-py3-none-any.whl
Size 247.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
641053558ecd0b647818c23eae8c712c276bd98df51e733a69bec3dfc01ec36b
BLAKE2b-256 checksum
How to use checksums
92ba39130692d5cb842270639b22880c559ca127870a9135ce3c4dbd8b155083
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.1

Release history Release notifications | RSS feed

This release
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