Skip to content

Latest commit

 

History

History

tket2-py

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

tket2

pypi codecov py-version

TKET2 is an open source quantum compiler developed by Quantinuum. Central to TKET2's design is its hardware agnosticism which allows researchers and quantum software developers to take advantage of its powerful compilation for many different quantum architectures.

This is the Python front-end for TKET2, providing a high-level interface for working with quantum circuits. See also the Rust library with the same name on crates.io.

Install

TKET2 can be installed via pip. Requires Python >= 3.10.

pip install tket2

Usage

See the Getting Started guide and the other examples.

Development

This package uses pyo3 and maturin to bind TKET2 functionality to python as the tket2 package.

Recommended:

A clean python 3.10 environment with maturin installed. At which point running maturin develop in this directory should build and install the package in the environment. Run pytest in this directory to test everything is working.

Don't forget to use the --release flag when using Badger and other heavy computational workloads.

See DEVELOPMENT.md for more information.

License

This project is licensed under Apache License, Version 2.0 (LICENCE or http://www.apache.org/licenses/LICENSE-2.0).