Skip to content

Commit e4474ea

Browse files
committed
docs: QuanuX global ecosystem overhaul
Redrafted the README to reflect the grand-scale vision of the Sovereign Quant Infrastructure. Documented Pillars I-V, including the 59ns Core, Strategy Forge, TopstepX Native Integration, Remote Annex, and Institutional Reconciliation. Injected the final Ritchie Wallace Rebuttal.
1 parent 791b1e2 commit e4474ea

1 file changed

Lines changed: 42 additions & 228 deletions

File tree

README.md

Lines changed: 42 additions & 228 deletions
Original file line numberDiff line numberDiff line change
@@ -1,164 +1,73 @@
1-
# 🚀 QuanuX
1+
# 🚀 QuanuX: The All-In-One Sovereign Quant Platform
22

3-
**QuanuX** is an early-stage, free open-source quantitative research, development, and algorithmic strategy development, trade manaagement & execution platform. ⚡️
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.
44

5-
This repository represents a **pre-release development snapshot** as the project approaches its first public technical milestone: `v0.0.1-pre`.
5+
> *“I know a couple of guys who are hoping to fire up some big Ambassadors at 11:59.”*
66
77
---
88

9-
## ⚠️ Project Status: Pre-Release
9+
## ⚡ Pillar I: The Ultra-Low Latency Core (59ns Execution)
1010

11-
QuanuX is currently in **active development** and should be considered **experimental**.
11+
**QuanuX is built on a physics-first execution model.**
1212

13-
- APIs, schemas, tools, and internal architecture may change
14-
- Features may be incomplete or non-functional
15-
- Documentation is evolving
16-
- Backward compatibility is not guaranteed
13+
- **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.
14+
- **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.
15+
- **The Trace:** See the verified 59ns tick-to-trade flash-crash survival data in [REPORTS/MISSION_CRITICAL_TRACE.md](REPORTS/MISSION_CRITICAL_TRACE.md).
16+
- **Zero PnL Drift:** Identical code-paths ensure that simulations and live production behave exactly the same.
1717

18-
This repository is being made public to support early testing, architectural review, experimentation, and visibility as the project approaches its initial release.
18+
## 🤖 Pillar II: The Strategy Forge & AI Architect
1919

20-
It is **not yet intended as a production-ready system**.
20+
**The Intelligence Layer.**
2121

22-
---
23-
24-
## 🧪 Versioning
25-
26-
Current development target: `v0.0.1-pre`
27-
28-
Semantic versioning will be introduced once public APIs are extended and stabilized.
29-
30-
---
31-
32-
## 🔥 Platform Features & Highlights
33-
34-
QuanuX developing something truly unique, bringing together the tools to make researching, building and deploying modular quantitative trading strategies easier than ever before. It's a comprehensive ecosystem for quantitative research & development with simple strategy creation, data management, broker integration and strategy execution using the latest in AI and distributed systems.
35-
36-
### 🎨 Design with AI in Figma
37-
**No other trading platform does this.**
38-
Developers can design their own UI/UX directly in **Figma** with the help of their AI assistants. By utilizing our **Model Context Protocol (MCP)** integration, we bridge the gap between design and code. Your AI agent can communicate QuanuX "agent-skills" and design tokens back to Figma via the MCP server, ensuring that every interface you build is beautiful, functional, and 100% **QuanuX compliant**.
22+
- **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.
23+
- **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.
24+
- **Visual Prototyping:** Real-time backtesting and visual strategy layout tools that completely remove the friction between concept and live deployment.
3925

40-
### 🧠 Native Embedded AI (Privacy-First)
41-
**Run `ollama serve` and `quanux_node` simultaneously — they connect automatically.**
42-
QuanuX features a **Native C++ AI Connector** built directly into the Execution Engine.
43-
- **Auto-Discovery**: QuanuX automatically detects running local models (Ollama, Llama.cpp, LM Studio) on startup.
44-
- **No API Keys**: Run entirely offline or on an air-gapped trading server.
45-
- **Zero Latency**: Query high-performance models (Llama 3, Mistral) over localhost in microseconds.
26+
## 🔌 Pillar III: Connectivity & Multi-Broker Support
4627

47-
### 🔩 Bolt-On Architecture & `quanuxctl`
48-
Flexibility is king. Our modular **bolt-on architecture** allows you to extend the platform effortlessly. Manage everything with **`quanuxctl`**, our powerful CLI tool designed to streamline your workflow, manage extensions, and control your environment with precision.
28+
**Global Access and Redundant Adapters.**
4929

50-
#### 🤓 Developer Experience
51-
We believe in classic engineering. Full documentation is built right into the terminal.
52-
```bash
53-
man quanuxctl
54-
```
55-
- **QuanuX-Common/**: Shared C++ core library (contains `StrategyInterface` and `OrderBookL3`).
56-
- **QuanuX-Backtesting-Engine/**: High-performance C++20 backtester with Python bindings (`quanux_backtest`).
57-
- **execution-node/**: The live C++ trading engine core.
58-
- **client/**: Frontends (Web, Desktop, Mobile, Tablet).
59-
- **server/**: Python Control Plane, Agents, and API.
60-
- **extensions/**: Language-specific plugins (C++, Python).
61-
### ⚡️ Distributed Execution Nodes (Bare Metal & Remote)
62-
**Unlimited Scale.**
63-
QuanuX introduces a game-changing **Execution Layer**. Spin up unlimited execution nodes on **bare metal servers** anywhere in the world.
64-
- **Colocation Ready**: Deploy nodes right next to exchange servers (e.g., Aurora CME Data Center) for **ultra-low latency**.
65-
- **"Push" Deployment**: Use `quanuxctl` to push your strategies to remote nodes instantly.
66-
- **Microservice Power**: Your strategies run as independent, high-performance Go binaries, decoupled from the core QuanuX server, yet able to be managed by a remote QuanuX client, CLI or via QuanuX server. HFT is possible with this architecture.
67-
68-
### 🐍 Anaconda Distribution (Industry First)
69-
**Bridging the gap between Data Science, Machine Learning, AI and Quantitative Trading.**
70-
QuanuX is the **first** quantitative trading platform to offer an official **Conda channel**.
71-
- **One Command Install**: `conda install quanux`
72-
- **Zero Dependency Hell**: We manage the complex web of Python and Rust dependencies so you don't have to.
73-
- **Cross-Platform**: Seamlessly consistent environments across Windows, Mac, and Linux.
30+
- **TopstepX Native Integration:** An exclusive, proprietary GraphQL / WebSocket bridge seamlessly supporting the TopstepX prop-firm platform for instantaneous risk synchronization.
31+
- **Institutional Adapters:** Formalized native support for `QuickFIX`, `OnixS`, and `Databento`. Bridge across multiple brokerages and liquidity providers with bit-identical engine parity.
32+
- **The Tipster Bridge:** A social/signal layer enabling secure, latency-aware signal distribution.
7433

75-
---
34+
## 📊 Pillar IV: The Observation Suite & The Annex
7635

77-
## 🤖 AI Agent & Architectural Rationale
36+
**Institutional-Grade Observation.**
7837

79-
QuanuX is built to be understood and extended by both humans and AI agents.
80-
To ensure our foundational architectural rules (such as the 59ns C++ latency path and the 64-byte L1 cache covenant) are preserved, we maintain a set of explicit instructions and skills:
38+
- **The Web Theater:** A high-fidelity, NATS-streamed audit interface for monitoring your real-time trades globally.
39+
- **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.
40+
- **Jacques-Mode:** A switchable UI toggle that morphs the Web Theater into a high-fidelity, baroque visual experience for auditing and executive reporting.
8141

82-
* **[Immortal Rationale](docs/IMMORTAL_RATIONALE.md)**: The core C++ engine architecture, historical latency decisions, and memory layouts.
83-
* **[Agent Skills Directory](.agent/skills/)**: High-fidelity AI operating procedures and capabilities logically separated by component domain (`SKILL.md`).
84-
* **Man Pages**: Operator runbooks logically defined in `server/docs/man`.
42+
## 🛡️ Pillar V: Institutional Reliability & Reconciliation
8543

86-
Agentic systems evaluating this repository must prioritize reading `docs/IMMORTAL_RATIONALE.md` before embarking on modifications to execution nodes, execution loops, or distributed architectures.
87-
88-
---
89-
## 🔌 Universal Connectivity & Integrations
90-
91-
The "Bolt-On" architecture means we integrate with **everything**.
92-
93-
### 🛠 Workflow & Analysis
94-
- **n8n**: Automate your trading operations. Trigger alerts, log trades, or manage risk with visual workflows.
95-
- **Sierra Chart**: The professional's choice. We support direct integration for advanced charting and data.
96-
- **QuanuX MCP**: MCP everywhere, agent-skills protocol throughout. BYO AI API-Key -- QuanuX guides AI and saves tokens.
97-
98-
---
44+
**Mathematical Parity and Safety.**
9945

100-
## 🏦 Supported Brokerages & Prop Firms
101-
102-
Trade where you want. QuanuX brings dozens of brokerages and prop firms under one roof.
103-
104-
### Proprietary Trading Firms
105-
- 🏆 **Topstep** (Native API Integration)
106-
- 🐂 **Apex Trader Funding**
107-
- 🦅 **Elite Trader Funding**
108-
- 💰 **Take Profit Trader**
109-
- 🚀 **OneUp Trader**
110-
- 🐂 **Bulenox**
111-
- 🎓 **Earn2Trade**
112-
- 🎯 **Uprofit**
113-
- ⏱️ **TickTickTrader**
114-
- 🦁 **Leeloo Trading**
115-
- *...and any other firm compatible with Rithmic.*
116-
117-
### Futures Brokerages
118-
- 🛡️ **Ironbeam Futures**
119-
-**Amp Futures**
120-
- 📉 **Discount Trading**
121-
- 🌊 **Edge Clear**
122-
- 🏎️ **Optimus Futures**
123-
- 🦉 **Tradovate**
124-
- *...and any other brokerage compatible with Rithmic API or ProjectX.*
125-
126-
> **Note**: Rithmic connectivity is provided by the first-class **Rithmic Extension**, managed directly via `quanuxctl`.
46+
- **Deterministic Ledgering:** Discover 1:1 transaction reconciliation via the `.qlog` high-speed binary journal.
47+
- **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`).
48+
- **Signed Deployments:** SHA-256 verification and Git-signed audit trails are strictly enforced for all production deployment codes.
12749

12850
---
12951

130-
131-
13252
## 🚀 Getting Started
13353

13454
### 1. Prerequisites
13555

13656
- **Python 3.10+** (Required for the server)
13757
- **Node.js v20+** & **pnpm** (Required for the client)
138-
- Enable pnpm via: `corepack enable`
13958
- **Rust & Cargo** (Required for **development** and building the Tauri desktop app)
140-
### 2. Installation
141-
142-
#### 🌟 Option A: Stable Release (Recommended)
143-
For the verified, cross-platform release (`v0.0.1-pre`), use Anaconda. This is the **official distribution** hosted by the QuanuX Organization.
14459

145-
1. **Configure Channels** (once):
146-
```bash
147-
conda config --add channels conda-forge
148-
conda config --add channels QuanuX
149-
```
60+
### 2. Installation (Anaconda - Industry First)
15061

151-
2. **Install**:
152-
```bash
153-
conda install quanux
154-
```
62+
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.
15563

156-
*This installs the stable application snapshot found at [QuanuX/quanux](https://github.com/QuanuX/quanux).*
157-
158-
#### 🧪 Option B: Active Development (Experimental)
159-
Clone this repository (`quantdiy/QuanuX`) if you want to contribute or access bleeding-edge, experimental features.
64+
```bash
65+
conda config --add channels conda-forge
66+
conda config --add channels QuanuX
67+
conda install quanux
68+
```
16069

161-
> **Warning**: This branch is in active flux and may contain unfinished features.
70+
### 3. Developer Source Installation
16271

16372
```bash
16473
# Clone the development repository
@@ -167,132 +76,37 @@ cd QuanuX
16776

16877
# Set up Python Virtual Environment
16978
python3 -m venv .venv
170-
source .venv/bin/activate # Windows: .venv\Scripts\activate
79+
source .venv/bin/activate
17180

17281
# Install Dependencies
173-
# This installs Python dependencies for the server
17482
pip install -r requirements.txt
175-
176-
# This installs Node dependencies for ALL client packages and server bridges
17783
pnpm install
17884
```
17985

180-
### 3. Development Environment Setup
181-
QuanuX supports a **Polyglot Development Experience**:
182-
* **VSCode**: Native support via `.vscode` configuration (C++, Python, React).
183-
* **CLion / Visual Studio**: Standardized `CMakePresets.json` for C++ components.
184-
* **Xcode**: Helpers to generate `.xcodeproj` files.
185-
* **Spyder**: Helpers to initialize `.spyproject` configuration.
186-
187-
To configure your preferred IDE, check `server/skills/project_maintenance/SKILL.md` or use the helper scripts in `scripts/`.
188-
18986
### 4. Configuration
19087

191-
QuanuX uses the OS Keyring to securely store API keys.
192-
193-
> **Note for Linux Users:** You may need to install system headers for the keyring backend (e.g., `libsecret-1-dev`, `dbus-x11`, or `gnome-keyring`). macOS and Windows use native system stores.
194-
195-
**Option A: Interactive Setup (Recommended)**
88+
QuanuX uses the OS Keyring to securely store API keys. You can set them up interactively:
19689

19790
```bash
19891
python -m server.cli.setup_secrets
19992
```
20093

201-
This utility prompts for:
202-
- `TOPSTEP__USERNAME`, `TOPSTEP__PASSWORD`, & `TOPSTEP__API_KEY`
203-
- `OPENAI_API_KEY`
204-
- `QUANUX_GEMINI_API_KEY`
205-
- `TRADINGVIEW_CLIENT_ID`
206-
207-
**Option B: Manual / Additional Keys**
208-
209-
You can also add keys via the **Integrations** page in the app, or manually using Python (e.g., for Gemini):
210-
211-
```bash
212-
# Example for Gemini
213-
# Note: Ensure the key name matches what the application expects (e.g. QUANUX_GEMINI_API_KEY)
214-
python -c "import keyring; keyring.set_password('QuanuX', 'QUANUX_GEMINI_API_KEY', 'your_api_key')"
215-
```
216-
217-
**Option C: Import from .env**
218-
219-
```bash
220-
# Create .env file with your keys (e.g. QUANUX_TOPSTEP__API_KEY=...)
221-
python -m server.cli.import_env
222-
```
223-
22494
### 5. Running the Application
22595

226-
You will need two terminal sessions.
227-
228-
**Terminal 1: Start the Server**
96+
**Terminal 1: Start the Core Server**
22997
```bash
230-
# Ensure venv is active
231-
source .venv/bin/activate
23298
uvicorn server.app.main:app --host 0.0.0.0 --port 8080 --reload
23399
```
234100

235-
**Terminal 2: Launch Desktop App**
101+
**Terminal 2: Launch the Cockpit (Tauri)**
236102
```bash
237103
pnpm -C client/desktop/tauri-app tauri dev
238104
```
239105

240-
### 6. Building for Production (Optional)
241-
242-
If you want to create a standalone executable (e.g., `.dmg`, `.exe`, or `.app`) rather than running in development mode:
243-
244-
```bash
245-
pnpm -C client/desktop/tauri-app tauri build
246-
```
247-
248-
This will output the installers/bundles to `client/desktop/tauri-app/src-tauri/target/release/bundle`.
249-
250-
---
251-
252-
## 📜 License
253-
254-
QuanuX is licensed under the **GNU Affero General Public License v3.0 (AGPLv3)**.
255-
256-
- You may use, modify, and distribute this software under the terms of the AGPL
257-
- If you run a modified version as a network service, you must make the source available
258-
259-
If you wish to use QuanuX in a way that is **not permitted under the AGPLv3**
260-
—for example, offering it as a closed-source or proprietary service—
261-
please contact the project owner to discuss **commercial licensing options**.
262-
263-
See the `LICENSE` file for full details.
264-
265-
---
266-
267-
## 🚧 Contributions
268-
269-
At this stage:
270-
271-
- The project is not yet accepting formal external contributions
272-
- Interfaces and internal boundaries are still settling
273-
- Contribution guidelines will be added once `v0.0.1` stabilizes
274-
275-
Public visibility is intended to support review and exploration, not yet coordinated development.
276-
277-
---
278-
279-
## 🧭 Disclaimer
280-
281-
This software is provided **as-is**, without warranty of any kind.
282-
283-
Nothing in this repository constitutes financial advice, trading advice, or investment recommendations.
284-
285-
---
286-
287-
## 🔭 What’s Next
288-
289-
QuanuX is approaching its first stable technical checkpoint.
290-
291-
Further documentation, examples, and contribution guidelines will follow as the project matures beyond the `v0.0.1` pre-release stage.
292-
293106
---
294107

295108
## 🏛️ The Final Institutional Rebuttal
109+
296110
> *"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."*
297111
>
298112
> — The QuanuX Foundation

0 commit comments

Comments
 (0)