pytket-dqc

Automated entanglement-efficient distribution of quantum circuits.

Table of Contents

• About
• Requirements
• Installing pytket-dqc
• Contributing

About

This package takes a quantum circuit and network description and produces a circuit distributed across the given network, using entanglement-assisted local operations and classical communication to implement non-local gates in the circuit, with the aim of reducing the amount of entanglement required for the circuit implementation. A more in-depth presentation of the methods implemented here can be found in the corresponding paper "Distributing circuits over heterogeneous, modular quantum computing network architectures".

Here we detail the steps required to install pytket-dqc. More thorough documentation of it use can be found here You may also find the example Jupyter notebooks in examples/ instructive.

Requirements

In addition to specified Python packages that will automatically be installed when you install pytket-dqc, the following packages are also required. We provide installation steps for MacOS, but they should apply just the same for Linux systems by replacing brew with your package manager (e.g. apt for Debian/Ubuntu users).

CMake

This is required for building KaHyPar. Please refer to Building KaHyPar for more details.

KaHyPar (with Python interface)

This is required for the hypergraph partitioning methods used in pytket-dqc. Note that continuous integration tests are run with v1.3.2, released with this commit and we recommend you use that version.

We use an experimental feature from KaHyPar that let us select a different maximum weight for each block of the partition (i.e. a different qubit capacity for each server). The python interface for this feature was added in this commit. It looks like KaHyPar >1.2.1 is the least requirement for this feature. If KaHyPar is built from their repository (following the instructions given below), this feature is automatically available.

Graphviz

This package is used for graph visualisation.

Installing pytket-dqc

1. Ensure that CMake, KaHyPar, and Graphviz are installed. See above for guidance on this.
2. In your terminal, navigate to the directory you wish to download pytket-dqc's source files to. (If unsure, then cd ~ is probably fine.)
3. Clone this repository with git clone git@github.com:CQCL/pytket-dqc.git.
4. Navigate to the cloned repository cd pytket-dqc.
5. Run pip install .

Testing pytket-dqc

You may wish to test your installation has succeeded.

You can do this by running pip install pytest to install pytest. Then running pytest tests -m "not high_compute from the directory that these source files were git cloned to. (The additional flag skips tests that will take a long time.) Assuming that all the tests pass then you have succeeded in installing pytket-dqc!

Contributing

If you wish to contribute to the development of pytket-dqc (which would be extremely welcome!), you can do so by creating a branch and submitting a PR.

For code consistency, we'd ask you to include type annotations on your code, and ensure that your code conforms to standards set by flake8 (with a line length of 79 characters). This will be checked automatically on any PRs submitted to this project, by mypy and flake8 respectively.