Skip to content

Commit 6aa3c90

Browse files
authored
Update README.md
1 parent 3fa9293 commit 6aa3c90

1 file changed

Lines changed: 56 additions & 2 deletions

File tree

README.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,56 @@
1-
# qector-decoder-workbench
2-
QECTOR Decoder v3 Workbench – Windows, Linux & macOS desktop app
1+
# QECTOR Decoder Workbench
2+
3+
Official desktop application (Windows / Linux / macOS) for the **QECTOR Decoder v3** quantum error-correction platform.
4+
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)
8+
9+
---
10+
11+
## Downloads
12+
13+
| Platform | File | Notes |
14+
|----------|------|-------|
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) ||
18+
19+
**Latest release**: [Releases page](https://github.com/GuillaumeLessard/qector-workbench/releases/latest)
20+
21+
Always verify the SHA-256 checksums published with each release.
22+
23+
---
24+
25+
## Features
26+
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)
32+
33+
---
34+
35+
## Licensing
36+
37+
Source-available.
38+
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
41+
42+
Contact: [admin@qector.store](mailto:admin@qector.store)
43+
44+
---
45+
46+
## Citation
47+
48+
```bibtex
49+
@software{lessard2026qector,
50+
author = {Guillaume Lessard},
51+
title = {{QECTOR Decoder v3}: Rust/Python Quantum Error Correction Decoding Platform},
52+
year = {2026},
53+
version = {0.6.9},
54+
url = {https://www.qector.store},
55+
orcid = {0009-0000-3465-3753}
56+
}

0 commit comments

Comments
 (0)