QDD Documentation

QDD is a decision diagram based quantum computing simulator that works as a Qiskit backend. It can reduce memory usage compared with typical state-vector simulators for circuits where the decision diagram representation remains compact.

Use this documentation for installation, common usage, source builds, testing, and API references.

User Guide

• Installation
  • Standard Package
  • MPI Package
  • Supported Environment
• Quick Start
• Usage
  • Backends
  • Run a Qiskit Circuit
  • Statevector Simulation
  • QDD Sampler
  • QDD Estimator
• Performance Characteristics
  • When QDD Tends To Be Fast
  • When QDD Can Be Slow
  • Example: Grover With Qiskit’s Grover Class
  • Example: Shor From IBM Quantum’s Tutorial
  • Example: H2 VQE With Qiskit Nature
  • Practical Selection Guide
  • Benchmark Script
  • References
• MPI Support
  • Prerequisites
  • Install From PyPI
  • Run Qiskit Code With MPI
  • Manual Build
• Citation

Development

• Build From Source
  • Requirements
  • Build C++ Targets and Wheel
  • Install the Built Wheel
  • Helper Script
• Testing
  • Python Tests
  • C++ Tests
  • Helper Script
• Development
  • Branches
  • Documentation
• Decision Diagram Internals
• MPI Internals
• How to build on FX1000
  • (1) Clone the repository
  • (2) Build
  • (3) Run
  • Tips

API Reference

• Python API
  • Provider
  • Backends
  • Jobs and Gates
  • Primitives
• C++ API
  • Decision Diagram Header
  • Cache Header
  • Table Header
  • Common Types