Skip to content

Commit 216d2a4

Browse files
authored
Update README.md
1 parent 6aa3c90 commit 216d2a4

1 file changed

Lines changed: 78 additions & 19 deletions

File tree

README.md

Lines changed: 78 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,95 @@
11
# QECTOR Decoder Workbench
22

3-
Official desktop application (Windows / Linux / macOS) for the **QECTOR Decoder v3** quantum error-correction platform.
3+
**Version 3.5.1** · Backend: [qector-decoder-v3==0.6.9](https://pypi.org/project/qector-decoder-v3/)
44

5-
**Python package**: [qector-decoder-v3 on PyPI](https://pypi.org/project/qector-decoder-v3/)
6-
**Website**: [https://www.qector.store](https://www.qector.store)
7-
**Author**: Guillaume Lessard (iD01t Productions) · ORCID: [0009-0000-3465-3753](https://orcid.org/0009-0000-3465-3753)
5+
Professional desktop application for quantum error correction research, evaluation, and documentation.
6+
7+
- 13 decoder algorithms
8+
- 9 code families (surface, toric, heavy-hex, bicycle qLDPC, …)
9+
- 47-tool Model Context Protocol (MCP) server for AI agents
10+
- Portable Windows executable · Linux .deb · macOS .dmg
11+
- Full GUI + command-line + headless MCP mode
12+
13+
**Website**: [https://www.qector.store](https://www.qector.store)
14+
**Author**: Guillaume Lessard / iD01t Productions · ORCID [0009-0000-3465-3753](https://orcid.org/0009-0000-3465-3753)
815

916
---
1017

1118
## Downloads
1219

1320
| Platform | File | Notes |
1421
|----------|------|-------|
15-
| Windows | `QECTOR-Workbench-x.y.z-windows-x64.exe` or portable zip | Recommended: portable version |
16-
| Linux | `QECTOR-Workbench-x.y.z-linux-x86_64.AppImage` | Make executable: `chmod +x *.AppImage` |
17-
| macOS | `QECTOR-Workbench-x.y.z-macos-arm64.dmg` (or Intel) | |
22+
| **Windows** | `QectorWorkbench-Portable.exe` or `.zip` | Fully portable, no install required |
23+
| **Linux** | `qector-workbench_3.5.1_amd64.deb` | Ubuntu 20.04+ / Debian 11+ |
24+
| **macOS** | `QectorWorkbench-3.5.1.dmg` | macOS 12+ (Apple Silicon & Intel) |
1825

19-
**Latest release**: [Releases page](https://github.com/GuillaumeLessard/qector-workbench/releases/latest)
26+
**[Latest Release](https://github.com/GuillaumeLessard/qector-workbench/releases/latest)**
2027

21-
Always verify the SHA-256 checksums published with each release.
28+
Always verify the SHA-256 checksums included with each release.
2229

2330
---
2431

25-
## Features
32+
## Quick Start
33+
34+
**Windows**
35+
36+
1. Extract the zip (or run the portable `.exe` directly)
37+
2. Double-click `QectorWorkbench-Portable.exe`
38+
39+
**Linux**
40+
41+
```bash
42+
sudo apt install ./qector-workbench_3.5.1_amd64.deb
43+
qector-workbench
44+
```
2645

27-
- Graphical interface for decoder selection, code generation, and batch runs
28-
- Integration with the `qector-decoder-v3` Python package
29-
- Benchmark orchestration (Workbench harness)
30-
- Stim / Sinter compatible workflows
31-
- Offline license token support (Ed25519)
46+
**macOS**
47+
48+
Mount the DMG and drag to Applications.
49+
50+
**MCP Server (AI agents)**
51+
52+
```bash
53+
QectorWorkbench-Portable.exe --mcp # Windows
54+
qector-workbench --mcp # Linux / macOS
55+
```
56+
57+
---
58+
59+
## Key Features
60+
61+
- Interactive GUI (Code Explorer, Decoder Lab, Benchmark Suite, Batch/Streaming, Diagnostics, Documentation Studio)
62+
- 13 decoders including exact Blossom MWPM, Union-Find family, BP-OSD, belief-matching, auto-router, hybrid cascade
63+
- 9 code families (graph-like + qLDPC)
64+
- Publication-grade charts and multi-format export (MD, JSON, HTML, LaTeX, PDF, SVG)
65+
- 47-tool MCP server (stdio JSON-RPC 2.0)
66+
- Automatic backend provisioning from PyPI on first run (subsequent runs fully offline)
67+
- Self-healing decoder engine
3268

3369
---
3470

3571
## Licensing
3672

37-
Source-available.
73+
**Workbench (this application)** — see `EULA.txt`
74+
Royalty-free for any purpose (including commercial) as long as QECTOR notices are retained.
75+
76+
**Backend (qector-decoder-v3)** — separately licensed
77+
Free for personal / academic / non-commercial research.
78+
Commercial use requires a paid license → [qector.store/pricing](https://www.qector.store/pricing)
79+
80+
---
81+
82+
## Documentation
3883

39-
- **Free**: personal, academic, educational, and non-commercial research use
40-
- **Commercial license required** for company use, commercial R&D, SaaS, OEM embedding, or revenue-linked work
84+
Included in releases:
4185

42-
Contact: [admin@qector.store](mailto:admin@qector.store)
86+
- `README.txt` – full package overview
87+
- `EULA.txt` – End User License Agreement
88+
- Platform user manuals (Windows / Linux / macOS)
89+
- `QECTOR_API_Reference.md` / `.pdf`
90+
- `QECTOR_MCP_Integration_Guide.pdf`
91+
- `QECTOR_Quick_Start_Guide.pdf`
92+
- `QECTOR_LLM_Manual.json` – machine-readable agent guide
4393

4494
---
4595

@@ -54,3 +104,12 @@ Contact: [admin@qector.store](mailto:admin@qector.store)
54104
url = {https://www.qector.store},
55105
orcid = {0009-0000-3465-3753}
56106
}
107+
```
108+
109+
---
110+
111+
## Related
112+
113+
- Core library: [GuillaumeLessard/qector-decoder](https://github.com/GuillaumeLessard/qector-decoder)
114+
- PyPI: [qector-decoder-v3](https://pypi.org/project/qector-decoder-v3/)
115+
- Website & commercial licensing: [qector.store](https://www.qector.store)

0 commit comments

Comments
 (0)