Skip to main content

Quantum matcha TEA python library for tensor network emulation of quantum circuits.

Project description

License Code style: black

Quantum Matcha Tea

Quantum Matcha Tea is a Tensor Network emulator for quantum circuits and linear optics circuits. You can define your circuits either in qiskit, or using Matcha's internal circuit interface Qcircuit.

If you use another quantum information library (such as cirq) we suggest to save your circuit in qasm format and then load it in qiskit.

The circuits ca be ran using the following backends:

  • numpy, using the CPU in python;
  • cupy, using the GPU in python.

Documentation

Here is the documentation. The documentation can also be built locally with sphinx with the following python packages:

  • sphinx
  • sphinx_rtd_theme

and running the command make html in the docs/ folder.

Installation

Independent of the use-case, you have to install the dependencies. Installing the optional dependencies will enable the use of more tensor modules (for instance, supporting GPUs).

Installation via pip

The package is available via PyPi and pip install qmatchatea. After cloning the repository, a local installation via pip is also possible via pip install ..

Optional dependencies

The following optional dependencies are not installed by default.

  • cupy: necessary to run on the GPU with the tensor_module="numpy". The installation guide can be found at the cupy website.
  • torch: necessary to run simulation with the tensor_module="torch". The installation guide can be found at the pytorch website.
  • tensorflow: necessary to run simulation with the tensor_module="tensorflow". The installation guide can be found at the tensorflow website.
  • jax: necessary to run simulation with the tensor_module="jax". The installation guide can be found at the jax website.

Testing the package

To test the python package qmatchatea simply run from the command: python3 -m unittest

License

The project qmatchatea from the repository py_api_quantum_matcha_tea is licensed under the following license:

Apache License 2.0

The license applies to the files of this project as indicated in the header of each file, but not its dependencies.

Project details


Download files

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

Source Distribution

qmatchatea-1.4.1.tar.gz (64.4 kB view details)

Uploaded Source

Built Distribution

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

qmatchatea-1.4.1-py3-none-any.whl (64.8 kB view details)

Uploaded Python 3

File details

Details for the file qmatchatea-1.4.1.tar.gz.

File metadata

  • Download URL: qmatchatea-1.4.1.tar.gz
  • Upload date:
  • Size: 64.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.11

File hashes

Hashes for qmatchatea-1.4.1.tar.gz
Algorithm Hash digest
SHA256 864071e9e4dfe6e1bc346551f3ba5570c2f103af64965c75f6a5d47a6997e4f8
MD5 52ae924bd4ee91291500c3350d28278f
BLAKE2b-256 f9b1174c87f99e2aad5a546ab428473c0236260404c6d5f4254265a42ba5455a

See more details on using hashes here.

File details

Details for the file qmatchatea-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: qmatchatea-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 64.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.11

File hashes

Hashes for qmatchatea-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a438c36c8a8cde50454d4f8313ac48e72e73ad828129edc98ad03c6f449866be
MD5 38af122baff71c6db39da477c3047b3a
BLAKE2b-256 498a35de8d0eaadb00343e3b15f0c30287e31759a0c911c92d6464e6229d92c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page