tensorcircuit-nightly

Pre-release

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

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(allow_state=True, batch=1024, format="count_dict_bin"))

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

Contributing

Status

This project is released by Tencent Quantum Lab and is created and maintained by Shi-Xin Zhang with current core authors Shi-Xin Zhang and Yu-Qin Chen. We also thank contributions from the lab and the open source community.

Citation

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

TensorCircuit: a Quantum Software Framework for the NISQ Era

which is also a good introduction to the software.

Guidelines

For contribution guidelines and notes, see CONTRIBUTING.

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

Contributors

_{Shixin Zhang} 💻 📖 💡 🤔 🚇 🚧 🔬 👀 🌍 ⚠️ ✅ 📢 💬	_{Yuqin Chen} 💻 📖 💡 🤔 🔬 ⚠️ ✅ 📢	_{Jiezhong Qiu} 💻 💡 🤔 🔬	_{Weitang Li} 💻 📖 🤔 🔬 ⚠️ 📢	_{Jiace Sun} 💻 📖 💡 🤔 🔬 ⚠️	_{Zhouquan Wan} 💻 📖 💡 🤔 🔬 ⚠️ ✅
_{Shuo Liu} 💡 🔬 ✅	_{Hao Yu} 💻 📖 🚇 ⚠️ ✅	_{Xinghan Yang} 📖 🌍 ✅	_JachyMeow ✅ 🌍	_{Zhaofeng Ye} 🎨	_erertertet 💻 📖 ⚠️
_{Yicong Zheng} ✅	_{Zixuan Song} 📖 🌍 💻 ⚠️	_{Hao Xie} 📖	_{Pramit Singh} ⚠️	_{Jonathan Allcock} 📖 🤔 📢	_nealchen2003 📖
_隐公观鱼 💻 ⚠️	_WiuYuan 💡

Research and Applications

DQAS

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

VQNHE

For the application of Variational Quantum-Neural Hybrid Eigensolver, see applications. Reference paper: https://arxiv.org/pdf/2106.05105.pdf (published in PRL) 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 (published in PRB).

Stark - DTC

For the numerical demosntration of discrete time crystal enabled by Stark many-body localization, see the Floquet simulation demo. Reference paper: https://arxiv.org/pdf/2208.02866.pdf (published in PRL).

Metadata

Release files for tensorcircuit-nightly 0.9.0.dev20230505

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.9.0.dev20230505
File	Size	Uploaded
tensorcircuit-nightly-0.9.0.dev20230505.tar.gz	293.3 kB	May 5, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for tensorcircuit-nightly 0.9.0.dev20230505
File	Interpreter	ABI	Platform	Reset
tensorcircuit_nightly-0.9.0.dev20230505-py3-none-any.whl 294.0 kB May 5, 2023	Python 3	none	any	Details

Total release size: 587.4 kB

Release files / tensorcircuit-nightly-0.9.0.dev20230505.tar.gz

Download URL	tensorcircuit-nightly-0.9.0.dev20230505.tar.gz
Size	293.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`8de8d3c44066368a185bbdd11dfacbcd36aff7b71cdb44835a2d7b713f84413b`
BLAKE2b-256 checksum How to use checksums	`fb2b4e42945b18e76a7c3941829b93145a00a0c0bdab15abfcf2af586ba76048`
Upload date	May 5, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.11.3`

Release files / tensorcircuit_nightly-0.9.0.dev20230505-py3-none-any.whl

Download URL	tensorcircuit_nightly-0.9.0.dev20230505-py3-none-any.whl
Size	294.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`88f5027ebead233402dd046264b4d4be41fe28a92a27d0f70aa9b5cd89f076bc`
BLAKE2b-256 checksum How to use checksums	`c888f545de25b072f1c10b334d83ebd9b2e441705be9e7768db896302a3123cc`
Upload date	May 5, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.11.3`