Zenith-FX/MQL5/Experts/QuantumForexTrader/INSTALLATION_COMPILATION_GUIDE.md

258 lines
6.7 KiB
Markdown
Raw Permalink Normal View History

# Quantum Forex Trader EA - Installation & Compilation Guide
## Quick Installation
### Step 1: Copy Files
Copy the entire `QuantumForexTrader` folder to your MT5 installation:
```
Source:
MQL5/Experts/QuantumForexTrader/
Destination:
C:\Users\User\AppData\Roaming\MetaQuotes\Terminal\
D0E8209F77C8CF37AD8BF550E51FF075\MQL5\Experts\QuantumForexTrader\
```
### Step 2: Compile
1. Open MetaTrader 5
2. Press **F4** to open MetaEditor
3. In Navigator, expand: **Experts****QuantumForexTrader**
4. Double-click: **QuantumForexTrader_Scalper.mq5**
5. Press **F7** to compile
### Expected Result
```
Compiling 'QuantumForexTrader_Scalper.mq5'...
Including: strategies\QuantumSignals.mqh
Including: strategies\QuantumAnalysis.mqh
Including: include\BinaryEncoder.mqh
Including: core\QuantumRiskManager.mqh
Result: 0 error(s), 0 warning(s)
Successfully compiled
```
## File Structure
```
QuantumForexTrader/
├── QuantumForexTrader_Scalper.mq5 # Main EA (compile this)
├── README.md # This file
├── EXECUTION_PLAN.md # Development plan
├── CODE_VALIDATION_REPORT.md # Quality assurance
├── core/ # Core functionality
│ └── QuantumRiskManager.mqh # Risk & position management
├── strategies/ # Trading strategies
│ ├── QuantumAnalysis.mqh # Quantum phase estimation
│ └── QuantumSignals.mqh # Signal generation
├── include/ # Utilities
│ └── BinaryEncoder.mqh # Price to binary conversion
├── docs/ # Complete documentation
│ ├── USER_MANUAL.txt # Complete user guide (27 KB)
│ ├── MASTER_GUIDE.md # Navigation hub
│ ├── QUICKSTART_QUANTUM.md # 5-minute setup
│ ├── TESTING_GUIDE.md # Testing procedures
│ ├── CONFIGURATION_GUIDE.md # All parameters explained
│ ├── QUANTUM_EA_README.md # Technical overview
│ └── IMPLEMENTATION_SUMMARY.md # Implementation details
├── configs/ # Configuration files
│ └── (Place your .ini files here)
└── tester/ # Strategy tester
└── (Place your .set files here)
```
## Compilation Verification
### Success Indicators ✅
- No errors shown in Errors tab
- No warnings shown in Errors tab
- Message: "Successfully compiled"
- File created: QuantumForexTrader_Scalper.ex5
### If Compilation Fails ❌
**Check 1: File Locations**
Ensure all .mqh files are in correct subdirectories:
- QuantumRiskManager.mqh → core/
- QuantumAnalysis.mqh → strategies/
- QuantumSignals.mqh → strategies/
- BinaryEncoder.mqh → include/
**Check 2: Include Paths**
Verify #include statements use backslashes:
```mql5
#include "strategies\\QuantumSignals.mqh"
#include "strategies\\QuantumAnalysis.mqh"
#include "core\\QuantumRiskManager.mqh"
```
**Check 3: File Integrity**
- No UTF-8 BOM markers (save as ANSI)
- No extra spaces in filenames
- File extensions correct (.mqh and .mq5)
## Quality Assurance
### Code Quality ✅
- **0 compilation errors** expected
- **0 warnings** expected
- All MQL5 syntax correct
- No reserved keyword conflicts
- Professional code structure
### Safety Features ✅
- Proper pip size calculation (no 10x bug)
- Correct SL/TP placement
- Drawdown protection
- Position size limits
- Safe array operations
- Error handling throughout
### Compatibility ✅
- MT5 Build 3960+
- All broker types (3, 4, 5-digit)
- Windows, Linux (via Wine), Mac
- Forex, Gold, Indices, Crypto
## Quick Start After Compilation
### 1. Attach to Chart
- Open EUR/USD chart
- Change timeframe to H1
- Drag EA from Navigator to chart
- Check "Allow Algo Trading"
- Click OK
### 2. Verify Running
- Look for ☺ smiley face in top-right corner
- Check Toolbox → Experts tab for initialization messages
### 3. Expected Log Messages
```
=== Quantum Forex Trader Initializing ===
Symbol: EURUSD
Timeframe: H1
Account Balance: 10000.00
=== Configuration ===
History Bars: 256
Confidence Threshold: 3.0%
Risk Per Trade: 1.0%
=== Quantum Forex Trader Initialized Successfully ===
```
## Default Settings
### For Beginners (Conservative)
```
InpRiskPercent: 0.5%
InpMaxPositions: 1
InpConfidenceThreshold: 0.05
InpMomentumThreshold: 0.15
InpStopLossPips: 50
InpTakeProfitPips: 100
```
### For Experienced (Moderate)
```
InpRiskPercent: 1.0%
InpMaxPositions: 3
InpConfidenceThreshold: 0.03
InpMomentumThreshold: 0.10
InpStopLossPips: 50
InpTakeProfitPips: 100
```
## Documentation
### Complete Guides Available
All documentation in `docs/` folder:
1. **USER_MANUAL.txt** (27 KB)
- Complete installation guide
- All 13 parameters explained
- Troubleshooting section
- 15-question FAQ
2. **CONFIGURATION_GUIDE.md** (17 KB)
- Parameter details with examples
- 6 ready-to-use presets
- Account size recommendations
- Optimization guide
3. **TESTING_GUIDE.md** (12 KB)
- 8-phase testing methodology
- Performance benchmarks
- Validation procedures
4. **QUICKSTART_QUANTUM.md** (5 KB)
- 5-minute setup guide
- Expected behaviors
- Common issues & fixes
5. **MASTER_GUIDE.md** (13 KB)
- Navigation hub for all docs
- Quick reference
- Best practices
## Support
### Troubleshooting
- Check `docs/USER_MANUAL.txt` Section 9
- See `docs/QUICKSTART_QUANTUM.md` for quick fixes
- Review `CODE_VALIDATION_REPORT.md` for technical details
### Common Issues
**Issue**: EA won't compile
**Fix**: Ensure all .mqh files in correct subdirectories
**Issue**: Include file not found
**Fix**: Verify backslashes in #include paths
**Issue**: Reserved keyword error
**Fix**: Already fixed (commit cf51d8d)
## Technical Information
### Code Statistics
- Main EA: 228 lines
- Core modules: 214 lines
- Strategies: 473 lines
- Utilities: 93 lines
- **Total**: 1,008 lines of professional MQL5 code
### Development
- Based on IBM Quantum concepts
- Follows ForexTrader v3.0/v3.2 patterns
- No critical bugs from base versions
- Production-quality code
- Thoroughly validated
### Version
- Version: 1.0
- Build: 2025-11-14
- Status: Production Ready
- Compilation: 0 errors, 0 warnings expected
## References
- **Original EAs**: ForexTrader Base → v3.2 in repository root
- **Quantum Concepts**: `IBM QUONTUM.txt` in repository root
- **Bug Fixes**: `BASE_VERSION_ISSUES.md` in repository root
- **Implementation**: `IMPLEMENTATION_V3.md` in repository root
---
**Ready to Trade**: Yes, after demo testing
**Compilation**: Ready
**Documentation**: Complete
**Support**: Full guides provided
**START HERE**: `docs/QUICKSTART_QUANTUM.md`