|
1 | 1 | # QuanuX: The Great Equalizer |
2 | 2 | *Biological Sovereignty in Algorithmic Execution* |
3 | 3 |
|
4 | | -QuanuX is not merely a trading engine. It is a living, deterministically audited, biological organism. Built for those who refuse to be boxed in by institutional infrastructure and "phony complexity," QuanuX resets the starting line. It is the absolute Equalizer, demanding nothing but **Intellect and Effort**. |
| 4 | +**QuanuX** intends to become a complete, end-to-end ecosystem for high-frequency execution, AI-driven strategy generation, and institutional-grade observation. Built for those who refuse to be limited by conventional infrastructure, QuanuX bridges the gap between AI-driven research and ultra-low latency execution. From bare-metal C++ cores to reactive cockpits, QuanuX provides the tools required to compete natively at the edge of the market. It is the absolute Equalizer, demanding nothing but intellect and effort. |
5 | 5 |
|
| 6 | +[](https://www.gnu.org/licenses/agpl-3.0) |
6 | 7 | [](https://isocpp.org/) |
7 | 8 |
|
8 | 9 | --- |
9 | 10 |
|
10 | | -## 🧬 The Biological Octave (The Mandala) |
11 | | -QuanuX operates under the paradigm of Biological Sovereignty. The core strategy is protected by form-fitting, protective membranes (Organelles), documented in our 8-section manual hierarchy: |
| 11 | +## ⚡ Pillar I: The Ultra-Low Latency Core (59ns Execution) |
| 12 | + |
| 13 | +**QuanuX is built on a physics-first execution model.** |
| 14 | + |
| 15 | +- **The Neural Singularity (16 TSC Cycles / ~8ns):** (In Development) By stripping away the standard OS routing latency, QuanuX leverages Solarflare EF_VI Hugepage Overlays to achieve a 143 to 16 TSC cycle reduction in market data ingress. |
| 16 | +- **Hardware Interlocks:** By utilizing a 64-byte L3-cache "Dead Drop," the **Sovereign Sentinel** (Core 5) provides 23ns risk validation across the CPU cache without OS context switching, while the **Execution Spreader** (Core 3) handles latency-sensitive Alpha generation. |
| 17 | +- **The Trace:** See the verified 59ns tick-to-trade flash-crash survival data in `REPORTS/MISSION_CRITICAL_TRACE.md`. |
| 18 | +- **The Sovereign Guarantee:** QuanuX ensures Binary Replay Parity via the HDF5-to-Parquet Databento pipeline. Identical code paths ensure backtests perfectly replay live structural executions with zero drift. |
| 19 | + |
| 20 | +## 🧬 Pillar II: The Biological Octave (Architecture) |
| 21 | + |
| 22 | +QuanuX operates under the paradigm of Biological Sovereignty. The core strategy is protected by form-fitting membranes (Organelles), documented in our 8-section manual hierarchy: |
12 | 23 |
|
13 | 24 | 1. **`quanux-spreader(1)` (The Metabolic Enzyme)**: The active execution catalyst. |
14 | 25 | 2. **`ritchie-interlock(2)` (The Immune System)**: Hard-coded risk thresholds and Apoptosis (`STATE_HALT`) laws. |
15 | 26 | 3. **`quanux-organelles(3)` (The Ribosomes)**: Extension APIs for growing new membranes. |
16 | 27 | 4. **`quanux-shm(4)` (The Cytoplasm)**: Lock-free, inter-cellular shared memory state. |
17 | 28 | 5. **`quanux-vault(5)` (The Memory Vacuole)**: HDF5 SWMR Journal for exact parity transcription. |
18 | | -6. **`quanux-arena(6)` (The Training Cortex / Thymus)**: The Neural Sandbox for simulated evolution via Synthetic Entropy. |
19 | | -7. **`quanux-cell(7) & quanux-aether(7)` (The Nucleus & Aether)**: The core architecture and documentation of Solarflare EF_VI kernel bypass. |
| 29 | +6. **`quanux-arena(6)` (The Training Cortex)**: The Neural Sandbox for simulated evolution via Synthetic Entropy. |
| 30 | +7. **`quanux-cell(7) & quanux-aether(7)` (The Nucleus & Aether)**: Solarflare EF_VI kernel bypass architecture. |
20 | 31 | 8. **`quanux-sentinel(8)` (The Homeostatic Admin)**: PTP synchronization and Cellular Regeneration routines. |
21 | 32 |
|
22 | | ---- |
| 33 | +## 🤖 Pillar III: The Strategy Forge & AI Architect |
23 | 34 |
|
24 | | -## ⚡ The Neural Singularity (16 TSC Cycles / ~8ns) |
25 | | -We do not operate in "The Room" (the Operating System). We operate in **The Aether**. |
| 35 | +**The Intelligence Layer & Nutrient Layer.** |
26 | 36 |
|
27 | | -By stripping away the 127-cycle "Tax" of standard OS routing, QuanuX leverages Solarflare EF_VI Hugepage Overlays to achieve a **143 to 16 TSC cycle reduction** in market data ingress. |
| 37 | +- **The Anaconda Synapse:** Deep integration with Anaconda (Conda) provides a seamless Python data science workflow. Evolve strategies and analyze HDF5 memory vacuoles in Python, then transfer the DNA to the C++ Core 3 Spreader. |
| 38 | +- **AI Strategy Architect:** An integrated AI Strategy Builder translates quant intent in natural language into high-performance, verified C++ and Rust execution logic. |
| 39 | +- **Figma-Grade UX:** A professional-grade research cockpit built with Tauri and React. Design UI natively in Figma and let MCP translate design tokens into a sub-millisecond visual response. |
28 | 40 |
|
29 | | -Coupled with the **Ghost Hand-off** zero-copy buffer and the **Kinetic Egress** (The Strike), the Nucleus perceives and reacts to the wire faster than thought. |
| 41 | +## 🔌 Pillar IV: Connectivity & Injectable Sovereignty |
30 | 42 |
|
31 | | ---- |
| 43 | +**Global Access and Redundant Adapters.** |
32 | 44 |
|
33 | | -## 🔬 The Anaconda Synapse (The Nutrient Layer) |
34 | | -Biological evolution requires a robust environment. QuanuX integrates deeply with **Anaconda (Conda)**, providing a seamless Python data science workflow. |
| 45 | +- **The Universal Translator (Sanctified Graft):** Using `Makefile.onixs`, users can swap the altruistic stub for the proprietary **OnixS Solarflare Binary Order Handler**. This achieves *Linguistic Singularity*—allowing the Native Nucleus to speak directly to the matching engine. |
| 46 | +- **TopstepX Native Integration:** A proprietary GraphQL/WebSocket bridge seamlessly supporting the TopstepX prop-firm platform. |
| 47 | +- **Institutional Adapters:** Formalized native support for `QuickFIX` and `Databento`. Bridge across brokerages with bit-identical engine parity. |
35 | 48 |
|
36 | | -Researchers can evolve strategies, analyze HDF5 memory vacuoles, and generate AI insights in a rich Python ecosystem, seamlessly transferring the resulting DNA to the C++ Core 3 Spreader for 26-cycle live execution. |
| 49 | +## 🌐 Pillar V: Universal Connectivity & Brokerages |
37 | 50 |
|
38 | | ---- |
| 51 | +**Trade where you want. QuanuX brings dozens of brokerages and prop firms under one roof.** |
| 52 | + |
| 53 | +### Proprietary Trading Firms |
| 54 | +- 🏆 **Topstep** (Native API Integration) |
| 55 | +- 🐂 **Apex Trader Funding** |
| 56 | +- 🦅 **Elite Trader Funding** |
| 57 | +- 💰 **Take Profit Trader** |
| 58 | +- 🚀 **OneUp Trader** |
| 59 | +- 🐂 **Bulenox** |
| 60 | +- 🎓 **Earn2Trade** |
| 61 | +- 🎯 **Uprofit** |
| 62 | +- ⏱️ **TickTickTrader** |
| 63 | +- 🦁 **Leeloo Trading** |
| 64 | +- *...and any other firm compatible with Rithmic.* |
| 65 | + |
| 66 | +### Futures Brokerages |
| 67 | +- 🛡️ **Ironbeam Futures** |
| 68 | +- ⚡ **Amp Futures** |
| 69 | +- 📉 **Discount Trading** |
| 70 | +- 🌊 **Edge Clear** |
| 71 | +- 🏎️ **Optimus Futures** |
| 72 | +- 🦉 **Tradovate** |
| 73 | +- *...and any other brokerage compatible with Rithmic API or ProjectX.* |
| 74 | + |
| 75 | +### 🛠 Workflow & Analysis Integrations |
| 76 | +- **n8n**: Automate your trading operations. Trigger alerts, log trades, or manage risk with visual workflows. |
| 77 | +- **Sierra Chart**: The professional's choice. We support direct integration for advanced charting and data. |
| 78 | +- **QuanuX MCP**: Agent-skills protocol throughout. Bring your own AI API-Key—QuanuX handles the context and saves tokens. |
| 79 | + |
| 80 | +## 🛡️ Pillar VI: Institutional Reliability & Reconciliation |
39 | 81 |
|
40 | | -## 🔌 The Universal Translator (Injectable Sovereignty) |
41 | | -The base chassis is altruistic and free. However, for those possessing the permissioned keys to the exchange native binary frequencies, QuanuX supports the **Sanctified Graft**. |
| 82 | +**Mathematical Parity and Safety.** |
42 | 83 |
|
43 | | -Using `Makefile.onixs`, users can swap the altruistic stub for the proprietary **OnixS Solarflare Binary Order Handler**. This achieves *Linguistic Singularity*—allowing the Native Nucleus to speak directly to the matching engine without translation interpolation. |
| 84 | +- **Deterministic Ledgering:** Discover 1:1 transaction reconciliation via the `.qlog` high-speed binary journal. |
| 85 | +- **The Ritchie FSM:** A completely deterministic Finite State Machine ensuring predictable recovery from all market failure modes (from `STATE_VOID` to `STATE_RECOVERY`). |
| 86 | +- **Signed Deployments:** SHA-256 verification and Git-signed audit trails are strictly enforced for all production deployments. |
44 | 87 |
|
45 | 88 | --- |
46 | 89 |
|
47 | | -## 🐝 The Meritocratic Promise |
48 | | -This is the Spaceboat. It is free. It asks for nothing but your effort. We are not just leveling the playing field; we are removing it entirely, allowing the unseen engineer to project their intent into the binary aether with zero friction. |
| 90 | +## 🚀 Getting Started |
| 91 | + |
| 92 | +### 1. Prerequisites |
| 93 | + |
| 94 | +- **Python 3.10+** (Required for the server) |
| 95 | +- **Node.js v20+** & **pnpm** (Required for the client) |
| 96 | +- **Rust & Cargo** (Required for **development** and building the Tauri desktop app) |
| 97 | + |
| 98 | +### 2. Installation (Anaconda - Industry First) |
| 99 | + |
| 100 | +QuanuX is the **first** quantitative trading platform to offer an official **Conda channel**—bridging the gap between Data Science and Quantitative Trading with zero dependency hell. |
| 101 | + |
| 102 | +```bash |
| 103 | +conda config --add channels conda-forge |
| 104 | +conda config --add channels QuanuX |
| 105 | +conda install quanux |
| 106 | +``` |
| 107 | + |
| 108 | +### 3. Developer Source Installation |
49 | 109 |
|
50 | | -### Documentation |
51 | | -Consult the manual: |
52 | 110 | ```bash |
53 | | -man 7 quanux-cell |
54 | | -man 7 quanux-aether |
55 | | -man 7 quanux-translator |
| 111 | +# Clone the development repository |
| 112 | +git clone https://github.com/quantdiy/QuanuX.git |
| 113 | +cd QuanuX |
| 114 | + |
| 115 | +# Set up Python Virtual Environment |
| 116 | +python3 -m venv .venv |
| 117 | +source .venv/bin/activate |
| 118 | + |
| 119 | +# Install Dependencies |
| 120 | +pip install -r requirements.txt |
| 121 | +pnpm install |
56 | 122 | ``` |
| 123 | + |
| 124 | +### 4. Configuration |
| 125 | + |
| 126 | +QuanuX uses the OS Keyring to securely store API keys. You can set them up interactively: |
| 127 | + |
| 128 | +```bash |
| 129 | +python -m server.cli.setup_secrets |
| 130 | +``` |
| 131 | + |
| 132 | +### 5. Running the Application |
| 133 | + |
| 134 | +**Terminal 1: Start the Core Server** |
| 135 | +```bash |
| 136 | +uvicorn server.app.main:app --host 0.0.0.0 --port 8080 --reload |
| 137 | +``` |
| 138 | + |
| 139 | +**Terminal 2: Launch the Cockpit (Tauri)** |
| 140 | +```bash |
| 141 | +pnpm -C client/desktop/tauri-app tauri dev |
| 142 | +``` |
| 143 | + |
| 144 | +--- |
| 145 | + |
| 146 | +## 📜 License |
| 147 | + |
| 148 | +QuanuX is licensed under the **GNU Affero General Public License v3.0 (AGPLv3)**. |
| 149 | + |
| 150 | +- You may use, modify, and distribute this software under the terms of the AGPL. |
| 151 | +- If you run a modified version as a network service, you must make the source available. |
| 152 | + |
| 153 | +See the `LICENSE` file for full details. |
| 154 | + |
| 155 | + |
0 commit comments