View on GitHub

Distributed Quantum Fourier Transformation in Qiskit and QNE-ADK

RIPE Quantum Internet Hackathon 2022

Installation

This chapter contains the installation instructions for the distributed quantum Fourier transformation (DQFT) software developed by “team Q-Harmonics” as part of the Quantum Internet Hackathon (QIH) 2022. For a general overview of the QIH 2022 hackathon and the team Q-Harmonics DQFT project see the README file.

These installation instructions have been tested on a MacBook Air running macOS Catalina, but they should work with little or no changes on any other platform including Windows or Linux.

We assume that you already have the following software installed on your computer:

Python 3.8.x: Needed to run the Python code in the repo.
Pip: Needed to install PyPI dependencies.
Git: Need to clone git repository from GitHub and work on it.
Some code editor: I use Visual Studio Code (VSC).
Some way to run Jupyter notebooks: I use the Microsoft Jupyter extension in Visual Studio Code.

On macOS we recommend using brew to install this software if you don’t already have it.

Minimal installation instructions

The minimal installation instructions allow you read all of the team Q-Harmonics code and to run the Qiskit-related code. To also run the QNE-ADK related code you will need to follow the additional instructions below.

Clone the repository

Clone the brunorijsman/quantum-internet-hackathon-20022 GitHub repository:

git clone https://github.com/brunorijsman/quantum-internet-hackathon-2022.git

In the remainder of these installation instructions, I will use the QIH_2022_ROOT environment variable to refer to the directory in which you cloned the repository:

export QIH_2022_ROOT=$(pwd)

Create and activate a Python virtual environment

Change directory to the newly created local clone:

cd $QIH_2022_ROOT/quantum-internet-hackathon-2022

Create a Python virtual environment:

python3.8 -m venv venv

Note:You must use Python3.8.x. QNE-ADK does not yet work with Python3.9.x or later. I have not tested with Python 3.7.x or earlier. I recommend using brew to install Python 3.8 on your Mac and using pyenv for making Python3.8 the default Python version for this project.

Activate the virtual environment:

source venv/bin/activate

Note: Every time you open a new shell or new terminal window, you must activate the virtual environment. Your command-line prompt includes (venv) when the virtual environment is active.

Install the dependencies

Upgrade pip to the latest version:

pip install --upgrade pip

Install the wheel package:

pip install wheel

Install the Qiskit textbook package:

pip install git+https://github.com/qiskit-community/qiskit-textbook.git#subdirectory=qiskit-textbook-src

Install the remaining required PyPI packages, which are specified in the file minimal-requirements.txt:

pip install -r minimal-requirements.txt

The minimal installation instructions described above are sufficient for downloading and viewing all of the team Q-Harmonics code and for running all Qiskit related code.

If you also want to run the QNE-ADK related code you must follow the additional installation steps listed below.

Make sure you execute the basic installation steps listed above first.

Also make sure that your virtual environment that you created above is still active (you should see (venv) in your prompt).

You will need a NetSquid account to download some of the dependencies. If you don’t already have a NetSquid account, go to the NetSquid website https://netsquid.org/, click on the Get NetSquid option in the menu, click on the Register now button, agree to the terms, choose a username and password and fill in the other information on the form.

Set the following environment variables to your NetSquid username and password:

export NETSQUID_USERNAME="Your NetSquid Username Here"
export NETSQUID_PASSWORD="Your NetSquid Password Here"

Install the Quantum Network Explorer Application Development Kit (QNE-ADK). We want version 0.1.0 because it is compatible with out modified versions of squidasm and netqasm (discussed below):

pip install qne-adk==0.1.0

Next we will install the squidasm and the netqasm packages.

Normally you would install these from the QuTech repository. However, QNE-ADK was missing some functionality that we needed to implement a distributed quantum Fourier transformation, namely:

The ability to have more than two qubits per node.
Support for the CROTZ gate.

We forked the squidasm and the netqasm repositories and added the needed functionality in a feature branch. We have not yet submitted a pull request to merge this new functionality back into the QuTech repositories. The installation instructions below describe how to install our forked code:

Go back to the parent directory where you cloned the quantum-internet-hackathon-2022 repository:

cd $QIH_2022_ROOT

Clone the unmodified QuTech squidasm repository:

pip install squidasm --extra-index-url https://$NETSQUID_USERNAME:$NETSQUID_PASSWORD@pypi.netsquid.org

Clone our fork of the squidasm repository:

git clone https://github.com/brunorijsman/squidasm.git

Go into the cloned directory:

cd squidasm

Checkout the feature branch that contains our missing features:

git checkout issue-39-add-controlled-z-rotation-arbitrary-angle

Install the module in our virtual environment: (make sure that you set the NETSQUID environment variables to contain your NetSquid username and password as described above):

pip install .