trevor-vincent / plaquette-simulator

Plaquette Simulator Plugin

The Plaquette-Simulator plugin extends the Plaquette error correction software, providing a high-performance Clifford simulator for multi-core CPUs and AMD/NVIDIA GPUs.

Installation

You can install just the python interface with (this quietly builds the C++ backend):

pip install -r requirements.txt
CMAKE_ARGS="-DKokkos_ENABLE_OPENMP=ON" python -m pip install .

The C++ backend can be built independently by

cmake -B build -DKokkos_ENABLE_OPENMP=ON -G Ninja
cmake --build build

You can run the python frontend tests with

make test-python

You can run the C++ backend tests with

make test-cpp

Supported backend options are "SERIAL", "OPENMP", "THREADS", "HIP" and "CUDA" and the corresponding build switches are -DKokkos_ENABLE_BACKEND=ON, where one needs to replace BACKEND. One can activate simultaneously one serial, one parallel CPU host (e.g. "OPENMP", "THREADS") and one parallel GPU device backend (e.g. "HIP", "CUDA"), but not two of any category at the same time. For "HIP" and "CUDA", the appropriate software stacks are required to enable compilation and subsequent use. Similarly, the CMake option -DKokkos_ARCH_{...}=ON must also be specified to target a given architecture. A list of the architectures is found on the Kokkos wiki. Note that "THREADS" backend is not recommended since Kokkos does not guarantee its safety.

Usage

Python Frontend

import plaquette_simulator as ps

init_to_zero = true
seed = 123423
batch_size = 10
num_qubits = 5

clifford_state = ps.CliffordState(num_qubits, batch_size, seed, init_to_zero)
clifford_state.apply_hadamard_gate(0)
clifford_state.apply_cnot_gate(0,1)
clifford_state.measure_qubit(0)

C++ Backend

#include "CliffordState.hpp"

int main(int argc, char *argv[]) {

    using namespace Plaquette;
    //a vector storing a flag that is 1 if the vertex is on the boundary

    int num_qubits = 5;
    int batch_size = 10;
    CliffordState clifford_state(num_qubits, batch_size);

    clifford_state.ApplyHadamardGate(0);
    clifford_state.ApplyControlNotGate(0,1);
    clifford_state.MeasureQubit(0);
}

Documentation

To generate the documentation you will need to install graphviz and doxygen. Then run

pip install -r doc/requirements.txt
make docs
firefox ./doc/_build/html/index.html