Metadata-Version: 2.4
Name: tket2
Version: 0.6.0
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Dist: pytket >=1.34, <2
Requires-Dist: hugr >=0.10.0, <0.11
Requires-Dist: tket2-eccs >=0.3.0, <0.4
Requires-Dist: tket2-exts >=0.3.0, <0.4
License-File: LICENCE
Summary: Quantinuum's TKET2 Quantum Compiler
Home-Page: https://github.com/CQCL/tket2
Author-email: TKET development team <tket-support@quantinuum.com>
Maintainer-email: TKET development team <tket-support@quantinuum.com>
License: Apache-2.0
Requires-Python: >=3.10
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: homepage, https://github.com/CQCL/tket2/tree/main/tket2-py
Project-URL: repository, https://github.com/CQCL/tket2/tree/main/tket2-py

# tket2

[![pypi][]](https://pypi.org/project/tket2/)
[![codecov][]](https://codecov.io/gh/CQCL/tket2)
[![py-version][]](https://pypi.org/project/tket2/)

  [codecov]: https://img.shields.io/codecov/c/gh/CQCL/tket2?logo=codecov
  [py-version]: https://img.shields.io/pypi/pyversions/tket2
  [pypi]: https://img.shields.io/pypi/v/tket2

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](https://crates.io/crates/tket2).


## Install

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

```sh
pip install tket2
```

## Usage

See the [Getting Started][getting-started] guide and the other [examples].

  [getting-started]: https://github.com/CQCL/tket2/blob/main/tket2-py/examples/1-Getting-Started.ipynb
  [examples]: https://github.com/CQCL/tket2/blob/main/tket2-py/examples/

## Development

This package uses [pyo3](https://pyo3.rs/latest/) and
[maturin](https://github.com/PyO3/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.

  [DEVELOPMENT.md]: https://github.com/CQCL/tket2/blob/main/DEVELOPMENT.md


## License

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

  [LICENCE]: https://github.com/CQCL/tket2/blob/main/LICENCE

