RegimeFlow Docs¶
RegimeFlow is a regime-aware quantitative trading stack for Python research, C++ backtesting, live broker execution, and packaging across Linux, Windows, and macOS.
Choose Your Path¶
| If you want to... | Read this next |
|---|---|
| Run something in 5 minutes | Quick Install |
| Build from source | Installation |
| Run a first source-based backtest | Quickstart (Backtest) |
| Work from Python | Python Overview |
| Evaluate live trading readiness | Live Overview |
| Consume RegimeFlow from CMake or vcpkg | Quick Install |
| Understand architecture and event flow | Explanation Overview |
What Works From Wheels Vs Source¶
| Surface | Status | Notes |
|---|---|---|
| Python wheels | Recommended | Fastest path for research users on supported platforms. |
| Source build | Recommended | Full C++ engine, plugins, tests, and optional integrations. |
| vcpkg overlay/custom registry | Supported | Best fit for CMake consumers. |
Linux .deb / .rpm artifacts |
Release artifact | Good for deployment-oriented installs; still tied to release packaging. |
| Homebrew | Experimental | Do not assume version parity unless the formula has been updated for the current release. |
The canonical support matrix and prerequisites live in Installation.
First 5 Minutes¶
- If you want the quickest working path, use Quick Install and install the Python wheel.
- If you need source builds or plugins, go to Installation.
- If you already have a checkout and want a runnable example, use Quickstart (Backtest).
Live Trading Boundary¶
RegimeFlow includes live adapters, but live support is not presented as blanket production validation.
Read these before treating a live configuration as deployable: - Live Overview - Brokers - Production Readiness - Resilience
Documentation Map¶
- Getting Started: installation, quick paths, troubleshooting, and repo layout
- Quant Guide: workflows for backtesting, regime detection, risk, execution, and walk-forward analysis
- Python: Python package, CLI, strategy patterns, and research workflow
- Reference: exact config keys, flags, plugin API, and public symbol coverage
- Explanation: architecture, event flow, execution semantics, and deeper engineering notes
- Tutorials: examples and end-to-end workflows
- Reports: generated reports and validation artifacts