Quration: Quantum Resource Estimation Toolchain

Quration is a toolchain for exploring design space of fault-tolerant quantum computer (FTQC) architectures and curate optimization strategies and co-design techniques to find a state-of-the-art system designs.

This project is planned by RIKEN and developed by RIKEN and Fixstars.
The development of Quration is in progress, and their backward compatibility might be broken in future updates.

License

• External libraries (./externals/) are re-distributed under each library's license.
• Application generators (./quration-algorithm/) are distributed only for research purpose.
• The other quration libraries (./quration-core/, ./quration-visualize/, ./quration-docs/) are distributed under MIT-license.

Features

Quration consists of three components; quration-algorithm, quration-core, and quration-visualizer.

See ./quration-docs/tutorial/ for tutorials of these programs.

• quration-algorithm: Generate popular quantum algorithms and their subroutines as Quration-IR

  • Quration-IR is a succinct LLVM-like language dedicated for evaluating large-scale FTQC applications.
  • Algorithm generators for the following applications are implemented.
    • Trotter-based quantum simulation
    • Qubitization-based quantum phase estimation by R. Babbush et al.
    • Shor's factoring by C. Gidney

• quration-core: Manipulate Quration-IR and compile them into a target instruction set.

  • Quration-IR can be handled with an application named qret. Avaialble commands for qret are as follows (see manual for details).
    • qret parse: Parse existing formats (e.g. QASM) into Quration-IR
    • qret print: Print Quration-IR as an LLVM-like form
    • qret simulate: Simulate Quration-IR with several types of backend
    • qret opt: Optimize Quration-IR with pre-defined or user-defined workflow
    • qret compile: Compile Quration-IR into pre-defined or user-defined instruction sets of FTQCs
    • qret profile: Profile compiled programs and generate resource estimation profiles
    • qret asm: Dump compiled programs in a simple ascii form
  • Currently available target instructions:
    • We currently support FTQC based on surface codes, lattice surgery, code-deformation-based S-gate, and magic-state cultivation, and communication.
      • SC_LS_FIXED_V0_Dim2: Standard architecture, i.e., 2D array of surface codes
      • SC_LS_FIXED_V0_Dim3: Architecture with several layers of 2D surface-code arrays allowing transversal CNOTs between layers
      • SC_LS_FIXED_V0_Dist: Standard distributed FTQC, where each nodes consists of 2D surface code arrays

• quration-visualizer: Visualize execution traces and compare resource estimation profiles on browers

Install Quration-Core and Quration-Algorithm

Currently we only support build from source. Pre-build executables, python libraries, and C++ shared library will be distributed soon.

Environment

We expect our library will work on Windows, MacOS, and Linux with compilers GCC, Clang, and MSVS. This library is tested on the following environments.

• Windows 11 + Microsoft Visual Studio 2022
• Ubuntu 24.04 + Clang

Install dependencies

• Install vcpkg:

  • vcpkg is a package manager for C++ libraries, which is used for downloading dependent C++ libraries.
  • See vcpkg installation page for how to install vcpkg.
  • Make sure that an environment variable VCPKG_ROOT is set to the path to vcpkg folder.

• Install cmake:

  • Windows: Install cmake from official web sites
  • Ubuntu: Instlal with apt install cmake

• Optional

  • Python: required if you want to build python binding
  • gridsynth: required if you want to decompose Pauli-rotation gates into Clifford+T
    • Since official binaries in gridsynth websites do not work on recent Linux environment, our builds are re-distributed with GNU GPL.
      • Windows: ./externals/bin/gridsynth.exe
      • Linux: ./externals/bin/gridsynth
      • MacOS: ./externals/bin/gridsynth_macos

Build process

Please type the following commands at the root of this repository.

cmake --preset dist
cmake --build --preset build-dist

Then, you can find the following binaries in ./build/bin folder for windows, and ./bin/main and ./bin/examples for Linux and MacOS.

• qret: main program
  • In the case of windows, it is dependent on qret-core.dll, yaml-cpp.dll, and boost_program_options-*.dll
• Quration-IR generators:
  • Shor's factoring and subroutines
    • create_period_finding: Generate the whole period finding programs.
    • create_multi_controlled_mod_bi_mul_imm: Generate circuits for Mod-bimultiplication.
    • create_add_craig: Generate craig-adder circuits.
    • create_add_cuccaro: Generate cuccaro-adder circuits.
  • Qubitization-based quantum phase estimation and subroutines:
    • create_qpe: Generate the whole qunatum phase estimation programs
    • create_select: Generate SELECT circuits
    • create_prepare: Generate PREPARE circuits
  • Trotter-based Quantum-dynamics simulation
    • create_trotter: Generate the whole dynamics simulation

quration-visualizer

quration-visualizer is a streamlit based web visualization of compiled FTQC programs.

Install

Install dependent python libraries with

pip install numpy pandas plotly streamlit graphviz

Usage

Then, you can run web applications as follows

• streamlit run visualize_compile_info.py : Visualizer for profile information
• streamlit run visualize_computational_process.py : Visualizer for traces of quantum programs