Skip to content

Commit 3c13e1f

Browse files
authored
Create install.md
1 parent cd4f4df commit 3c13e1f

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

install.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Installation Guide — QECTOR Decoder v0.6.6
2+
3+
> ⚠️ **LICENSING & COMPLIANCE NOTICE**
4+
> QECTOR Decoder is **source-available**, not open source. It is free for personal, academic, and non-commercial research use.
5+
> **Commercial, institutional, lab, or product-integration use requires a paid commercial license.**
6+
> View pricing and request evaluation access at: **[https://qector.store/pricing](https://qector.store/pricing)**
7+
> Official contact: **admin@qector.store**
8+
9+
---
10+
11+
## 📦 Recommended Installation (Pre-compiled Binary)
12+
13+
The public repository serves as the Python interface, documentation, and test suite. The high-performance proprietary Rust core is **not included** in this public repository.
14+
15+
For all standard use cases, install the pre-compiled, optimized binary wheel directly from PyPI. This guarantees bit-identical, syndrome-faithful performance without requiring any local C++ or Rust toolchains.
16+
17+
### 1. Create a Virtual Environment (Recommended)
18+
```bash
19+
# Windows
20+
py -3.11 -m venv .venv
21+
.\.venv\Scripts\Activate.ps1
22+
23+
# Linux / macOS
24+
python3 -m venv .venv
25+
source .venv/bin/activate

0 commit comments

Comments
 (0)