Skip to content

Commit ff9795b

Browse files
committed
docs: harden PyPI install instructions
1 parent 9d69c94 commit ff9795b

1 file changed

Lines changed: 37 additions & 7 deletions

File tree

PYPI_README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,24 @@ QECTOR Decoder v3 provides a Python package backed by a native Rust extension fo
66

77
Website: https://www.qector.store
88
Repository: https://github.com/GuillaumeLessard/qector-decoder
9+
PyPI: https://pypi.org/project/qector-decoder-v3/
910
Commercial licensing: https://www.qector.store
1011

1112
---
1213

1314
## Installation
1415

16+
Recommended command:
17+
1518
```bash
1619
pip install qector-decoder-v3
1720
```
1821

19-
Supported package target for the public release workflow:
22+
Verify the install:
2023

21-
- Python 3.9 to 3.13
22-
- Linux x86_64 wheels
23-
- Windows x64 wheels
24-
- macOS arm64 wheels
25-
- Source distribution for custom/source builds
24+
```bash
25+
python -c "from qector_decoder_v3 import UnionFindDecoder, BlossomDecoder; print('QECTOR OK')"
26+
```
2627

2728
Optional research and validation extras:
2829

@@ -39,6 +40,35 @@ pip install "qector-decoder-v3[all]"
3940

4041
---
4142

43+
## Supported public wheels
44+
45+
QECTOR v0.5.x public releases target standard CPython wheels for:
46+
47+
| Platform | Wheel status |
48+
|---|---|
49+
| Linux x86_64 | Published |
50+
| Windows x64 | Published |
51+
| macOS arm64 / Apple Silicon | Published |
52+
| macOS Intel x86_64 | Not published in v0.5.x public CI |
53+
| CPython free-threaded builds such as `cp313t` | Not published in v0.5.x |
54+
55+
Supported Python classifiers are standard CPython 3.9 to 3.13.
56+
57+
Windows note: do not force `py -m pip` unless you have checked which interpreter the Windows launcher selected. If `py` selects a free-threaded interpreter such as `python3.13t.exe`, pip may fall back to a source build and fail because the public repository does not ship the proprietary Rust core. Use the standard active Python environment instead:
58+
59+
```powershell
60+
pip install qector-decoder-v3
61+
python -c "from qector_decoder_v3 import UnionFindDecoder, BlossomDecoder; print('QECTOR OK')"
62+
```
63+
64+
Check your Python launcher targets with:
65+
66+
```powershell
67+
py -0p
68+
```
69+
70+
---
71+
4272
## Quick start
4373

4474
```python
@@ -156,7 +186,7 @@ QECTOR Decoder v3 is source-available.
156186

157187
Personal, academic, educational and non-commercial research use is allowed under the repository license. Company use, funded institutional work, SaaS, hosted API deployment, OEM integration, redistribution, paid consulting, or commercial benchmarking requires a commercial license.
158188

159-
Commercial licensing:
189+
Website and commercial licensing:
160190

161191
https://www.qector.store
162192

0 commit comments

Comments
 (0)