Skip to content

Commit c51b573

Browse files
authored
Update install.md
1 parent 3b6378e commit c51b573

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

install.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,74 @@ For all standard use cases, install the pre-compiled, optimized binary wheel dir
2222
```powershell
2323
py -3.11 -m venv .venv
2424
.\.venv\Scripts\Activate.ps1
25+
26+
```
27+
28+
**Linux / macOS:**
29+
30+
```bash
31+
python3 -m venv .venv
32+
source .venv/bin/activate
33+
34+
```
35+
36+
### 2. Install via PyPI
37+
38+
Upgrade `pip` first to ensure compatibility with modern binary wheels, then install QECTOR:
39+
40+
```bash
41+
python -m pip install --upgrade pip
42+
python -m pip install qector-decoder-v3
43+
44+
```
45+
46+
*(Optional)* To install with compatibility layers and benchmarking tools:
47+
48+
```bash
49+
python -m pip install "qector-decoder-v3[stim,bench]"
50+
51+
```
52+
53+
### 3. Verify Installation
54+
55+
Run the following command to confirm the binary is correctly installed and functioning:
56+
57+
```bash
58+
python -c "from qector_decoder_v3 import UnionFindDecoder, BlossomDecoder; import qector_decoder_v3; print(f'QECTOR OK - v{qector_decoder_v3.__version__}')"
59+
60+
```
61+
62+
**Expected Output:**
63+
64+
```text
65+
QECTOR OK - v0.6.6
66+
67+
```
68+
69+
---
70+
71+
## 🏢 Commercial & Source Access
72+
73+
If your institution requires a custom build, specific feature flags (e.g., isolated CUDA/OpenCL configurations), or source-code review for security due diligence, this is **only available under a commercial license or Non-Disclosure Agreement (NDA)**.
74+
75+
To request access to the restricted technical archive or discuss enterprise deployment:
76+
77+
* **Web:** [https://qector.store/pricing](https://qector.store/pricing)
78+
* **Email:** [admin@qector.store](https://www.google.com/search?q=mailto%3Aadmin%40qector.store)
79+
80+
---
81+
82+
## 🔧 Common Troubleshooting
83+
84+
| Issue | Solution |
85+
| --- | --- |
86+
| **`ERROR: Could not find a version that satisfies the requirement`** | Ensure you are using Python 3.9, 3.10, 3.11, or 3.12. Upgrade pip: `python -m pip install --upgrade pip`. |
87+
| **`ImportError: DLL load failed / .so not found`** | The pre-compiled wheel may be incompatible with highly unusual OS configurations. Ensure you are on a standard 64-bit Windows, Linux, or macOS environment. |
88+
| **Missing optional dependencies (e.g., `stim`, `pymatching`)** | These are not bundled in the base wheel. Install them explicitly: `python -m pip install stim pymatching sinter`. |
89+
| **GPU acceleration not detected** | The base PyPI wheel includes CPU and standard GPU fallbacks. For specialized enterprise GPU deployments, contact [admin@qector.store](https://www.google.com/search?q=mailto%3Aadmin%40qector.store) for custom build options. |
90+
91+
---
92+
93+
*© 2024–2026 Guillaume Lessard. All Rights Reserved. Protected by timestamped archival (Zenodo DOI) and commercial licensing terms.*
94+
95+
```

0 commit comments

Comments
 (0)