gavindiaz/QuantumTerminal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README.md

Browse Source
This commit is contained in:
wJubran
2026-05-21 20:12:32 +03:00
committed by GitHub
parent 76541e39ac
commit 65a3ff7abb
1 changed files with 10 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -20
View File
@@ -21,10 +21,10 @@ Unlike traditional platforms that rely on lagging indicators (like RSI or MACD),
## 📸 Screenshots ## 📸 Screenshots
### Trading Interface — XAUUSD with Volatility Bands & Order Management ### Trading Interface — XAUUSD with Volatility Bands & Order Management
![Trading Interface](./screenshots/screenshot_1.jpg) ![Trading Interface](https://raw.githubusercontent.com/wJubran/QuantumTerminal/main/screenshots/screenshot_1.jpg)
### Volatility Cones — Probability-Based Price Envelopes ### Volatility Cones — Probability-Based Price Envelopes
![Volatility Cones](./screenshots/screenshot_2.jpg) ![Volatility Cones](https://raw.githubusercontent.com/wJubran/QuantumTerminal/main/screenshots/screenshot_2.jpg)
--- ---
@@ -35,7 +35,6 @@ Quantum Terminal is built to handle ultra-fast data streams from the most reliab
- **MetaTrader 5 (MT5):** Direct integration via Python API for Forex, Crypto, and CFD markets. - **MetaTrader 5 (MT5):** Direct integration via Python API for Forex, Crypto, and CFD markets.
- **Rithmic:** High-frequency, sub-millisecond tick processing for CME Futures (NQ, ES). - **Rithmic:** High-frequency, sub-millisecond tick processing for CME Futures (NQ, ES).
- **Tradovate:** Seamless integration for retail futures traders. - **Tradovate:** Seamless integration for retail futures traders.
*(The platform features a dedicated `focus_tick_loop` ensuring the chart you are actively watching refreshes at maximum FPS without bottlenecking the system).* *(The platform features a dedicated `focus_tick_loop` ensuring the chart you are actively watching refreshes at maximum FPS without bottlenecking the system).*
### 2. 📐 Advanced Quantitative Models (النماذج الكمية المتقدمة) ### 2. 📐 Advanced Quantitative Models (النماذج الكمية المتقدمة)
@@ -85,46 +84,35 @@ QuantumTerminal/
### Prerequisites ### Prerequisites
- **Python 3.10** or higher. - **Python 3.10** or higher.
- **MetaTrader 5** (if you intend to use the MT5 data feed). - **MetaTrader 5** (If you intend to use the MT5 data feed).
- `Node.js` (optional, if you wish to re-package the Electron shell). - `Node.js` (Optional, if you wish to re-package the Electron shell).
### Installation ### Installation
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://github.com/wJubran/QuantumTerminal.git git clone [https://github.com/wJubran/QuantumTerminal.git](https://github.com/wJubran/QuantumTerminal.git)
cd QuantumTerminal/backend cd QuantumTerminal/backend
``` ```
2. Install Python dependencies: 2. Install Python dependencies:
```bash ```bash
pip install fastapi uvicorn websockets watchfiles yfinance MetaTrader5 pip install fastapi uvicorn websockets watchfiles yfinance MetaTrader5
``` ```
3. Run the Backend Server:
3. Run the backend server:
```bash ```bash
python launcher.py python launcher.py
``` ```
4. The terminal will automatically serve the UI on `http://127.0.0.1:8502` and launch your default browser. 4. The terminal will automatically serve the UI on `http://127.0.0.1:8502` and launch your default browser.
*(To run as a standalone desktop app, you can package the `electron_shell` directory using Electron Forge or Electron Builder.)* *(To run as a standalone desktop app, you can package the `electron_shell` directory using Electron Forge or Electron Builder).*
--- ---
## 🛠️ Contributing (المساهمة) ## 🛠️ Contributing (المساهمة)
This is a community-driven project! If you are a Python developer, Quant, or React engineer, your pull requests are welcome.
This is a community-driven project. If you are a Python developer, Quant, or React engineer, your pull requests are welcome.
- **Areas needing help:** Enhancing thread safety for MT5 in `data_server.py`, adding new broker providers (like Interactive Brokers), and rebuilding an open-source React UI. - **Areas needing help:** Enhancing thread safety for MT5 in `data_server.py`, adding new broker providers (like Interactive Brokers), and rebuilding an open-source React UI.
---
## ⚖️ Disclaimer ## ⚖️ Disclaimer
*Quantum Terminal is for educational and analytical purposes only. Trading financial markets carries a high level of risk and may not be suitable for all investors. The mathematical models provided by this software are probabilistic, not predictive.* *Quantum Terminal is for educational and analytical purposes only. Trading financial markets carries a high level of risk and may not be suitable for all investors. The mathematical models provided by this software are probabilistic, not predictive.*
---
## 📄 License ## 📄 License
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for more details. This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for more details.