Skip to content

Commit 3b6378e

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

1 file changed

Lines changed: 11 additions & 49 deletions

File tree

install.md

Lines changed: 11 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Installation Guide — QECTOR Decoder v0.6.6
22

3-
> ⚠️ ****LICENSING** & **COMPLIANCE** **NOTICE**** > **QECTOR** Decoder is **source-available**, not open source. It is free for personal, academic, and non-commercial research use. > **Commercial, institutional, lab, or product-integration use requires a paid commercial license.** > View pricing and request evaluation access at: **[https://qector.store/pricing](https://qector.store/pricing)** > Official contact: **[admin@qector.store](mailto:admin@qector.store)**
3+
> ⚠️ **LICENSING & COMPLIANCE NOTICE**
4+
>
5+
> **QECTOR Decoder is source-available, not open source.** It is free for personal, academic, and non-commercial research use.
6+
>
7+
> **Commercial, institutional, lab, or product-integration use requires a paid commercial license.**
8+
> * **View pricing & evaluation access:** [https://qector.store/pricing](https://qector.store/pricing)
9+
> * **Official contact:** [admin@qector.store](mailto:admin@qector.store)
410
511
---
612

@@ -12,51 +18,7 @@ For all standard use cases, install the pre-compiled, optimized binary wheel dir
1218

1319
### 1. Create a Virtual Environment (Recommended)
1420

15-
```bash # Windows py -3.11 -m venv .venv .\.venv\Scripts\Activate.ps1
16-
17-
# Linux / macOS
18-
19-
python3 -m venv .venv source .venv/bin/activate
20-
21-
## 2. Install via PyPI
22-
23-
Upgrade `pip` first to ensure compatibility with modern binary wheels, then install **QECTOR**:
24-
25-
```bash python -m pip install --upgrade pip python -m pip install qector-decoder-v3 ```
26-
27-
*(Optional)* To install with compatibility layers and benchmarking tools:
28-
29-
```bash python -m pip install *qector-decoder-v3[stim,bench]* ```
30-
31-
## 3. Verify Installation
32-
33-
Run the following command to confirm the binary is correctly installed and functioning:
34-
35-
```bash python -c "from qector_decoder_v3 import UnionFindDecoder, BlossomDecoder; import qector_decoder_v3; print(f'**QECTOR** OK - v{qector_decoder_v3.__version__}')" ```
36-
37-
**Expected Output:** ```text **QECTOR** OK - v0.6.6 ```
38-
39-
---
40-
41-
## 🏢 Commercial & Source Access
42-
43-
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**)**.
44-
45-
To request access to the restricted technical archive or discuss enterprise deployment:
46-
- **Web**: [https://qector.store/pricing](https://qector.store/pricing)
47-
- **Email**: [admin@qector.store](mailto:[admin@qector.store](mailto:[admin@qector.store](mailto:admin@qector.store)))
48-
49-
---
50-
51-
## 🔧 Common Troubleshooting
52-
53-
| Issue | Solution |
54-
| :--- | :--- |
55-
| **`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`. |
56-
| **`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. |
57-
| **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`. |
58-
| **GPU acceleration not detected** | The base PyPI wheel includes CPU and standard GPU fallbacks. For specialized enterprise GPU deployments, contact `[admin@qector.store](mailto:[admin@qector.store](mailto:admin@qector.store))` for custom build options. |
59-
60-
---
61-
62-
*© **2024****2026** Guillaume Lessard. All Rights Reserved. Protected by timestamped archival (Zenodo **DOI**) and commercial licensing terms.* ```
21+
**Windows (PowerShell):**
22+
```powershell
23+
py -3.11 -m venv .venv
24+
.\.venv\Scripts\Activate.ps1

0 commit comments

Comments
 (0)