Skip to content

Latest commit

Β 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

QECTOR Logo

QECTOR Decoder Workbench

Professional Quantum Error Correction Analysis Suite
17 Decoders Β· 10 Code Families Β· 85-Tool MCP Server Β· Apple Silicon Native

Version Backend Python MCP Tools Platform License

Website Β· Quick Start Β· Features Β· Downloads Β· CHANGELOG Β· License


πŸ“– Overview

QECTOR Decoder Workbench is a production-grade desktop application for quantum error correction (QEC) research, evaluation, and documentation. Built on the high-performance qector-decoder-v3 Rust/PyO3 engine, it provides interactive decoding, batch simulation, hardware-accelerated compute, and a full local-only MCP server for LLM/AI agent integration.

Zero Install Β· Zero Config Β· Zero Dependencies Mount. Drag. Decode.

This repository is a release-only distribution mirror of the v1.0.2 macOS build. It contains no source files β€” only the release artifacts listed below. Binary packages are published on the Releases page.


πŸš€ Quick Start

Native .dmg (Recommended)

1.  Download  QectorWorkbench-1.0.2-arm64.dmg  from Releases
2.  Double-click the .dmg to mount it
3.  Drag  QectorWorkbench.app  into your /Applications folder
4.  Launch QectorWorkbench from Spotlight or Launchpad β€” no installation required
5.  The bundled decoder activates automatically on first run
# If macOS Gatekeeper flags the downloaded bundle:
xattr -dr com.apple.quarantine /Applications/QectorWorkbench.app

CLI Mode

# Define binary alias
APP="/Applications/QectorWorkbench.app/Contents/MacOS/QectorWorkbench"

"$APP" --cli decode --family rotated_surface --distance 5 --decoder blossom
"$APP" --cli benchmark --family toric --distance 7 --samples 10000
"$APP" --cli diagnostics

MCP Server (AI/LLM Integration)

Launches a stdio JSON-RPC 2.0 MCP server with all 85 tools. The server is local-only and communicates through stdio; it does not open an external network connection. No window is required to run the headless MCP mode.

Manual Claude Desktop configuration (~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "qector": {
      "command": "/Applications/QectorWorkbench.app/Contents/MacOS/QectorWorkbench",
      "args": ["--mcp"]
    }
  }
}

Note for Claude users: To seamlessly integrate these MCP tools directly into Claude Desktop or Claude Code, check out the official plugin at https://github.com/GuillaumeLessard/qector-claude-plugin β€” both the macOS releases of this workbench are fully compatible with it. See the Claude Plugin Compatibility section below.


πŸ“₯ Downloads

v1.0.2 release assets (all available on the Releases page, each with SHA-256 digests in SHA256SUMS.txt):

Artifact Contents
QectorWorkbench-1.0.2-arm64.dmg Native QectorWorkbench.app bundle (Apple Silicon) + EULA.txt + SBOM.json
SHA256SUMS.txt SHA-256 digests of every release artifact
SBOM.json Software Bill of Materials β€” cryptographic SHA-256 manifest for lab compliance audits

Fully local, no network required. The app bundle embeds the decoder wheel and provisions it into a per-user managed site on first launch, so a lab machine with no internet access runs the complete workbench β€” including the MCP server.

Runtime data (logs, exported documents, managed decoder site) is written to ~/Library/Application Support/QectorWorkbench. Override the location entirely with the QECTOR_DATA_DIR environment variable.

Windows and Linux artifacts are built from the same air-gapped source policy and include SHA-256 manifests; see the platform mirror repositories.

Verified v1.0.2 Build Facts

Item Value
Workbench app 1.0.2
Decoder backend qector-decoder-v3 1.0.0 bundled wheel
MCP server 85 tools over stdio JSON-RPC 2.0
MCP protocol 2024-11-05
Decoders 17
Code families 10
Target architecture Apple Silicon (arm64, macOS 12+)
Code signing Ad-hoc signature with Hardened Runtime + entitlements

Repository Files

File Purpose
README.md This document
CHANGELOG.md Release history
EULA.txt End User License Agreement
SECURITY.md Security policy
CODE_OF_CONDUCT.md Code of conduct
CONTRIBUTING.md Contribution guidelines
assets/logo_banner.png Project banner

✨ Features

πŸ–₯️ Nine Interactive Tabs + Live Console

πŸ”¬ Code Explorer

Build and inspect 10 code families with configurable parameters. View qubit/check counts, distance, code rate, and interactive Tanner graph visualizations.

πŸ§ͺ Decoder Lab

Interactive single-syndrome decoding with 17 decoder algorithms. Tunable BP-OSD parameters, resilient fallback mode, clear cache controls, and detailed correction analysis.

πŸ“Š Benchmark Suite

Configurable decode benchmarks with throughput, latency (mean / p50 / p99 / min / max), and multi-panel Matplotlib charts. Export results to JSON.

⚑ Batch & Streaming

Batch decoding with explicit CPU / CUDA / OpenCL routing. Streaming decode with sliding-window commit semantics and live logical error rate tracking.

πŸ•˜ History

Persistent decode-session history with re-inspection of past syndromes, corrections, and exported artifacts.

πŸ–§ Hardware & System

Auto-detect CUDA, OpenCL, and CPU backends. Hardware-aware decoder recommendations via hardware_routing.recommend().

🩺 Diagnostics & Auto-Debug

Full environment/decoder/hardware self-diagnostics and qd.doctor health checks. Automatic multi-decoder fallback with complete attempt trace analysis.

πŸ“„ Documentation Studio

Deposit-ready export in 8 formats: Markdown, JSON, HTML, LaTeX, PDF, SVG, plus .zenodo.json and CITATION.cff. Reports carry a five-figure publication suite (Tanner graph, parity sparsity, decoder latency, logical failure fraction, speed/accuracy Pareto front), a Methods section, a Data Availability statement and a formatted citation.

🏷️ Lab Info & Microsoft Entra ID

Deposit metadata for generated reports: lead author, ORCID, institution, DOI, funding and keywords. It also exposes a fail-closed Microsoft Entra ID posture for lab evaluation; live identity sign-in is disabled in the air-gapped build.


🧬 Supported Code Families (10)

Family Type Description
repetition Graphlike 1D repetition code
ring Graphlike Ring topology
rotated_surface Graphlike Rotated planar surface code
unrotated_surface Graphlike Standard planar surface code
toric Graphlike Periodic toric code
heavy_hex Graphlike IBM heavy-hexagon lattice
hypergraph_product Graphlike CSS code from repetition-code seed
bicycle qLDPC Quantum LDPC bicycle code
bivariate_bicycle qLDPC IBM bivariate bicycle (BB) code family
color_code Color Triangular & 2D color codes

βš™οΈ Decoder Algorithms (17)

Decoder Strategy Notes
union_find Approximate Fast cluster-growth matching
fast_union_find Approximate Optimized UF variant
blossom Exact MWPM Weight-optimal, matches PyMatching LER
sparse_blossom Near-optimal Sparse graph MWPM approximation
bp_osd Iterative Belief propagation + OSD for qLDPC codes
auto Auto-select Self-selects best backend
hybrid Combined Multi-strategy hybrid decoder
lookup_table Exact Table-based for small codes (≀ 20 checks)
predecoded Staged Pre-decoded syndrome correction
auto_router Policy Dispatches best decoder per code topology
hybrid_cascade Staged UF pre-filter β†’ Blossom/BP-OSD escalation
gnn_belief_matching Neural GNN-weighted belief matching
belief_matching Hybrid BP posteriors reweight exact Blossom MWPM
two_stage Decoupled Independent X/Z sector decoders for CSS/color codes
ambiguity_cluster Cluster Partition ambiguous checks into local clusters
colour_code DEM-native BP-OSD hypergraph decoder for 3-body color codes
space_time Multi-round Space-time decoder for phenomenological & circuit-level decoding

Resilient mode: When enabled, the workbench automatically falls back through compatible decoders if the selected one cannot handle the current code family β€” and reports exactly what happened.


πŸ€– 85-Tool MCP Server

Full Model Context Protocol integration for headless AI/LLM workflows:

  • Transport: stdio JSON-RPC 2.0 (protocol version 2024-11-05)
  • No HTTP bridge, no port binding β€” pure stdin/stdout newline-delimited JSON-RPC
  • All 85 tools wired to the live backend API
  • Per-tool 60-second timeouts, busy guards, and 10 MB frame limits protect long-running agents
Tool Categories
Category Tools
Decoding decode_syndrome, decode_single, decode_with_options, decode_syndrome_blossom, decode_syndrome_cascade, diagnostic_decode, resilient_decode, probe_decoders, sparse_blossom_radix_neighbors, gnn_belief_match_decode, belief_match_decode, two_stage_decode, ambiguity_cluster_decode, colour_code_decode, decode_hyperedge, decode_mmap, decode_dem, compare_all_decoders
Batch & Streaming batch_decode, batch_decode_gpu, parallel_batch_decode, native_streaming, stream_decode
Benchmarking benchmark_decoder, run_benchmark, run_ler_benchmark, hybrid_cascade_stats, compare_benchmarks, decoder_benchmark_suite, estimate_threshold, finite_size_scaling, get_statistics
Code Management list_code_families, list_codes, build_code_from_matrix, get_code_properties, analyze_code_family, analyze_error_patterns, analyze_logicals, generate_parity_check, compatible_decoders, compat_report, compatibility_matrix, get_decoder_info, list_decoders
DEM & Stim build_dem, import_stim
Hardware & System get_hardware_info, get_system_info, get_backend_health, native_recommend, recommend_decoder
Diagnostics & Compliance self_diagnostics, doctor_diagnostics, version_info, check_updates, compliance_attestation, get_entra_posture, get_identity_info, mcp_health, mcp_status, get_server_env
Documentation & Export generate_documentation, export_benchmark, export_figure, export_session, generate_reproducibility_package
Resources & Config get_resources, get_resource, get_results, clear_results, delete_resource, register_client, list_clients, get_config, set_config, reset_config, clear_decoder_cache
Licensing get_license_info, verify_license_token, set_license_key_file, flush_usage
Research neural_predecoder_train, import_syndrome
Meta list_tools

πŸ”§ CLI Reference

/Applications/QectorWorkbench.app/Contents/MacOS/QectorWorkbench <command> [options]

Global Flags

These flags are available on all commands:

Flag Description
--json Output raw results in JSON format
--no-color Disable ANSI colors
--no-banner Suppress ASCII header banner
--output, -o Redirect output to a file (sanitized)
--verbose, -v Enable verbose logging / details
--quiet, -q Suppress banners and warning prints
--config, -c Path to JSON config file to load parameters
--version, -V Show version information and exit

Subcommands (22)

Command Description
decode Decode a single syndrome (supports --dry-run)
benchmark Run decoder benchmarks (supports --dry-run)
probe Probe compatible decoders for a code
diagnostics Full environment & decoder diagnostics
hardware Detect and report hardware backends
list-codes List all available code families
list-decoders List all decoder algorithms
docgen Generate documentation in multiple formats
version Show version information
compare Compare multiple decoders on the same code
batch Batch decode multiple syndromes
stream Streaming decode workflow (supports --dry-run)
train Train neural predecoder
export Export a complete decode session
import Import external syndrome data (CSV, JSON, .npy)
matrix Return the full decoder/code compatibility matrix
serve Launch local REST API service
doctor Run 15-check environment diagnostic
compliance Run zero-egress / offline compliance attestation
entra Optional Microsoft Entra ID SSO readiness (off by default)
decode_mmap Out-of-core memmap decoding of large syndromes
completions Generate shell completions for bash/zsh/PowerShell

Examples

# Decode with exact Blossom MWPM on a rotated surface code
"$APP" --cli decode \
    --family rotated_surface --distance 5 \
    --decoder blossom --error-rate 0.05

# Compare multiple decoders on a rotated surface code
"$APP" --cli compare \
    --family rotated_surface --distance 5 \
    --decoders blossom,bp_osd,union_find

# Batch decode 1000 samples on CPU
"$APP" --cli batch \
    --family rotated_surface --distance 5 \
    --backend cpu --samples 1000

# Run a sliding window streaming decode session
"$APP" --cli stream \
    --family rotated_surface --distance 5 \
    --window 5 --n-rounds 100

# Display compatibility matrix as an ASCII table
"$APP" --cli matrix --format table

# Verify the air-gapped / zero-egress compliance posture
"$APP" --cli compliance

πŸ“‹ System Requirements

Component Requirement
OS macOS 12 Monterey or later
Architecture Apple Silicon (arm64) native
Runtime None β€” the .app bundles everything
RAM 4 GB minimum, 8 GB recommended
Disk ~200 MB installed
Display Not required for CLI / MCP headless modes

πŸ›‘οΈ Air-Gapped Hardening Status

The v1.0.2 public package is designed for offline lab use after download and extraction. Implemented in this release:

  • Bundled decoder wheel activation works without internet access
  • MCP transport is stdio only; the packaged MCP mode does not bind an HTTP port
  • Version checks resolve against the bundled local baseline, not a network update service
  • Runtime data can be redirected with QECTOR_DATA_DIR
  • License keys are encrypted at rest with machine-derived Fernet keys; export path traversal is sanitized
  • All documentation exports and deposit sidecars carry SHA-256 sidecar manifests
  • App bundle is ad-hoc signed with Hardened Runtime; an SBOM (SBOM.json) ships in every release

πŸ€– Claude Plugin Compatibility

The macOS v1.0.2 release of QECTOR Decoder Workbench is fully compatible with the official QECTOR Claude Plugin (qector-claude-plugin) for Claude Code and Claude Desktop:

  • The plugin's bundled qector-library (8 stable tools) and qector-bench (29 research tools) MCP servers run against the same qector-decoder-v3 1.0.0 backend that the workbench provisions β€” versions match exactly (qector-decoder-v3==1.0.0).
  • Use the workbench's --mcp server, the plugin's two stdio MCP servers, or both at once β€” all are local-only with zero network egress.
  • The plugin ships 13 slash commands (/qec-decode, /qec-threshold-sweep, /qec-benchmark, /qec-dem, …), 5 specialized agents (researcher, developer, validator, sysadmin, hardware engineer), 28 domain skills, and enforces the same HΒ·c ≑ s mod 2 fail-closed verification used by the workbench.

Plugin requirements: Python 3.10+, qector-decoder-v3==1.0.0, mcp==1.2.0, NumPy.


⚠️ Honest Performance Posture

Following the upstream QECTOR Decoder v3 documentation:

All logical-error-rate, throughput, and latency figures are hardware-, driver-, seed-, and workload-dependent simulation results β€” regenerate them on your own target hardware before quoting.

  • PyMatching remains the speed leader on standard surface-code MWPM
  • QECTOR's exact blossom decoder matches PyMatching's logical error rate but is not faster
  • Key strengths: batch throughput via approximate Union-Find, qLDPC coverage via BP-OSD, and GF(2) syndrome correctness (HΒ·c ≑ s mod 2)
  • This is a research and evaluation platform, not a real-time fault-tolerant hardware decoding stack

πŸ“„ License

Workbench (this application)

Source-available under EULA.txt. Grants a royalty-free, worldwide license to use, execute, copy, and distribute the software for any purpose β€” including commercial, academic, and personal use β€” provided embedded "QECTOR" notices and watermarks are retained (EULA Β§2).

Backend (qector-decoder-v3)

Separately licensed, source-available Rust/Python platform by the same author:

  • βœ… Free for personal, academic, educational, and non-commercial research
  • πŸ’Ό Commercial use (company R&D, SaaS, hosted API, OEM, redistribution) requires a paid license
  • πŸ”„ 60-day commercial evaluation available, creditable against a license

The workbench depends on qector-decoder-v3 at runtime. Honor the backend's license terms for any commercial deployment.


🀝 Support & Contact

Website www.qector.store
Commercial Licensing admin@qector.store
Support admin@qector.store
Pricing qector.store/pricing

QECTOR Decoder Workbench v1.0.2
Built on qector-decoder-v3 v1.0.0 (Rust/PyO3 core)

Β© 2026 Guillaume Lessard / iD01t Productions
ORCID 0009-0000-3465-3753

Powered by QECTOR

About

Production-grade desktop application for QEC research on macOS (.dmg & .app). 17 decoders, 10 code families, Apple Silicon/Accelerate support, and 85-tool MCP Server.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors