Skip to content

Commit 883ab02

Browse files
committed
docs(quanuX): operation event horizon - fix missing commit
Adding finalized Great Equalizer README details to tracking.
1 parent d7b43b8 commit 883ab02

1 file changed

Lines changed: 35 additions & 92 deletions

File tree

README.md

Lines changed: 35 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,57 @@
1-
# 🚀 QuanuX: The All-In-One Sovereign Quant Platform
1+
# QuanuX: The Great Equalizer
2+
*Biological Sovereignty in Algorithmic Execution*
23

3-
**QuanuX** is a complete, end-to-end ecosystem for high-frequency execution, AI-driven strategy generation, and institutional-grade observation. It is a modular, high-fidelity quant ecosystem designed to eliminate the gap between AI-driven research and ultra-low latency execution. From bare-metal C++ cores to Figma-designed research cockpits, QuanuX provides the tools required to compete at the edge of the market.
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**.
45

5-
> *“I know a couple of guys who are hoping to fire up some big Ambassadors at 11:59.”*
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7+
[![C++20](https://img.shields.io/badge/C++-20-blue.svg)](https://isocpp.org/)
68

79
---
810

9-
## ⚡ Pillar I: The Ultra-Low Latency Core (59ns Execution)
11+
## 🧬 The Biological Octave (The Mandala)
12+
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:
1013

11-
## ⚡ Pillar I: The Ultra-Low Latency Core (Deterministic Survivability)
12-
13-
**QuanuX is built on a physics-first execution model.**
14-
15-
- **AMP Architecture:** The core is isolated into distinct hardware threads. The **Sovereign Sentinel** (Core 5) handles absolute risk interlocking, while the **Execution Spreader** (Core 3) handles the latency-sensitive Alpha generation.
16-
- **Hardware Interlocks:** By utilizing a 64-byte L3-cache "Dead Drop," the Sentinel can provide 23ns risk validation across the CPU cache without OS context switching, functioning alongside the **HDF5 Vault** as the primary risk and audit layers.
17-
- **The Trace:** See the verified 59ns tick-to-trade flash-crash survival data in [REPORTS/MISSION_CRITICAL_TRACE.md](REPORTS/MISSION_CRITICAL_TRACE.md).
18-
- **The Sovereign Guarantee:** *QuanuX is the only open-source engine with Binary Replay Parity via the HDF5-to-Parquet Databento pipeline.* Identical code paths ensure that backtests perfectly replay live structural executions with zero drift.
19-
20-
## 🤖 Pillar II: The Strategy Forge & AI Architect
21-
22-
**The Intelligence Layer.**
23-
24-
- **AI Strategy Architect:** An integrated AI Strategy Builder that translates complex quant intent in natural language into high-performance, verified C++ and Rust execution logic.
25-
- **Figma-Grade UX:** A professional-grade research cockpit built with Tauri and React/Tailwind v4. Design your UI/UX natively in Figma and let our MCP integration translate design tokens into a sub-millisecond visual response.
26-
- **Visual Prototyping:** Real-time backtesting and visual strategy layout tools that completely remove the friction between concept and live deployment.
27-
28-
## 🔌 Pillar III: Connectivity & Multi-Broker Support
29-
30-
**Global Access and Redundant Adapters.**
31-
32-
- **TopstepX Native Integration:** An exclusive, proprietary GraphQL / WebSocket bridge seamlessly supporting the TopstepX prop-firm platform for instantaneous risk synchronization.
33-
- **Institutional Adapters:** Formalized native support for `QuickFIX`, `OnixS`, and `Databento`. Bridge across multiple brokerages and liquidity providers with bit-identical engine parity.
34-
- **The Tipster Bridge:** A social/signal layer enabling secure, latency-aware signal distribution.
35-
36-
## 📊 Pillar IV: The Observation Suite & The Annex
37-
38-
**Institutional-Grade Observation.**
39-
40-
- **The Web Theater:** A high-fidelity, NATS-streamed audit interface for monitoring your real-time trades globally.
41-
- **The Critic (Remote Annex):** A physically isolated DuckDB audit node, designed to sit on a remote server (e.g., Antarctica) for deep-dive historical forensics without stealing a single CPU cycle from the Execution Spreader.
42-
- **Jacques-Mode:** A switchable UI toggle that morphs the Web Theater into a high-fidelity, baroque visual experience for auditing and executive reporting.
43-
44-
## 🛡️ Pillar V: Institutional Reliability & Reconciliation
45-
46-
**Mathematical Parity and Safety.**
47-
48-
- **Deterministic Ledgering:** Discover 1:1 transaction reconciliation via the `.qlog` high-speed binary journal.
49-
- **The Ritchie FSM:** A completely deterministic Finite State Machine ensuring safe, predictable, and mathematically provable recovery from all market failure modes (from `STATE_VOID` to `STATE_RECOVERY`).
50-
- **Signed Deployments:** SHA-256 verification and Git-signed audit trails are strictly enforced for all production deployment codes.
14+
1. **`quanux-spreader(1)` (The Metabolic Enzyme)**: The active execution catalyst.
15+
2. **`ritchie-interlock(2)` (The Immune System)**: Hard-coded risk thresholds and Apoptosis (`STATE_HALT`) laws.
16+
3. **`quanux-organelles(3)` (The Ribosomes)**: Extension APIs for growing new membranes.
17+
4. **`quanux-shm(4)` (The Cytoplasm)**: Lock-free, inter-cellular shared memory state.
18+
5. **`quanux-vault(5)` (The Memory Vacuole)**: HDF5 SWMR Journal for exact parity transcription.
19+
6. **`quanux-arena(6)` (The Training Cortex / Thymus)**: The Neural Sandbox for simulated evolution via Synthetic Entropy.
20+
7. **`quanux-cell(7) & quanux-aether(7)` (The Nucleus & Aether)**: The core architecture and documentation of Solarflare EF_VI kernel bypass.
21+
8. **`quanux-sentinel(8)` (The Homeostatic Admin)**: PTP synchronization and Cellular Regeneration routines.
5122

5223
---
5324

54-
## 🚀 Getting Started
55-
56-
### 1. Prerequisites
25+
## ⚡ The Neural Singularity (16 TSC Cycles / ~8ns)
26+
We do not operate in "The Room" (the Operating System). We operate in **The Aether**.
5727

58-
- **Python 3.10+** (Required for the server)
59-
- **Node.js v20+** & **pnpm** (Required for the client)
60-
- **Rust & Cargo** (Required for **development** and building the Tauri desktop app)
28+
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.
6129

62-
### 2. Installation (Anaconda - Industry First)
30+
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.
6331

64-
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.
65-
66-
```bash
67-
conda config --add channels conda-forge
68-
conda config --add channels QuanuX
69-
conda install quanux
70-
```
71-
72-
### 3. Developer Source Installation
73-
74-
```bash
75-
# Clone the development repository
76-
git clone https://github.com/quantdiy/QuanuX.git
77-
cd QuanuX
32+
---
7833

79-
# Set up Python Virtual Environment
80-
python3 -m venv .venv
81-
source .venv/bin/activate
34+
## 🔬 The Anaconda Synapse (The Nutrient Layer)
35+
Biological evolution requires a robust environment. QuanuX integrates deeply with **Anaconda (Conda)**, providing a seamless Python data science workflow.
8236

83-
# Install Dependencies
84-
pip install -r requirements.txt
85-
pnpm install
86-
```
37+
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.
8738

88-
### 4. Configuration
39+
---
8940

90-
QuanuX uses the OS Keyring to securely store API keys. You can set them up interactively:
41+
## 🔌 The Universal Translator (Injectable Sovereignty)
42+
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**.
9143

92-
```bash
93-
python -m server.cli.setup_secrets
94-
```
44+
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.
9545

96-
### 5. Running the Application
46+
---
9747

98-
**Terminal 1: Start the Core Server**
99-
```bash
100-
uvicorn server.app.main:app --host 0.0.0.0 --port 8080 --reload
101-
```
48+
## 🐝 The Meritocratic Promise
49+
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.
10250

103-
**Terminal 2: Launch the Cockpit (Tauri)**
51+
### Documentation
52+
Consult the manual:
10453
```bash
105-
pnpm -C client/desktop/tauri-app tauri dev
54+
man 7 quanux-cell
55+
man 7 quanux-aether
56+
man 7 quanux-translator
10657
```
107-
108-
---
109-
110-
## 🏛️ The Final Institutional Rebuttal
111-
112-
> *"We have provided the 'Adapters' the industry expects. We have provided the QuickFIX and OnixS connectivity the institutions require. But make no mistake: underneath the 'Aerospace' documentation, we are firing the Big Ambassadors. If you're looking for 'state of the art,' you're looking at it. Bee 🐝 kind, please rewind—unless you've joined the club."*
113-
>
114-
> — The QuanuX Foundation

0 commit comments

Comments
 (0)