2 releases

0.1.0-alpha.2 Jun 11, 2024
0.1.0-alpha.1 May 24, 2024

#75 in Programming languages

Download history 107/week @ 2024-05-20 59/week @ 2024-05-27 30/week @ 2024-06-03 146/week @ 2024-06-10

342 downloads per month



tket2: The Hardware Agnostic Quantum Compiler

build_status msrv codecov

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 state of the art compilation for many different quantum architectures.

Circuits are represented using the HUGR IR defined in the hugr crate. TKET2 augments Hugr with

  • The Circuit trait, providing a high-level interface for working with HUGRs representing quantum circuits
  • a HUGR extension with quantum operations
  • A composable pass system for optimising circuits
  • A number of built-in rewrite utilities and passes for common optimisations

This crate is interoperable with tket1 circuits via its serial encoding.

Using TKET2

Defining a circuit in TKET2 is currently done by using the low-level hugr Builder API, or by loading tket1 circuits from JSON files.

use tket2::{Circuit, Hugr};

// Load a tket1 circuit.
let mut circ: Hugr = tket2::json::load_tk1_json_file("test_files/barenco_tof_5.json").unwrap();

assert_eq!(circ.qubit_count(), 9);
assert_eq!(circ.num_gates(), 170);

// Traverse the circuit and print the gates.
for command in circ.commands() {
    println!("{:?}", command.optype());

// Render the circuit as a mermaid diagram.
println!("{}", circ.mermaid_string());

// Optimise the circuit.
tket2::passes::apply_greedy_commutation(&mut circ);

Please read the API documentation here.


  • portmatching Enables pattern matching using the portmatching crate.

  • rewrite-tracing Adds opt-in tracking of the rewrites applied to a circuit.

Recent Changes

See CHANGELOG for a list of changes. The minimum supported rust version will only change on major releases.

Developing TKET2

See DEVELOPMENT.md for instructions on setting up the development environment.


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


~308K SLoC