Skip to content

Getting Started

This section is the onboarding hub. Use it to choose the right install and runtime path before you dive into the deeper guides.

Choose Your Path

If you want to... Start here
Install the Python package and run a backtest quickly Quick Install
Build RegimeFlow from source Installation
Run the first source-based backtest Quickstart (Backtest)
Use RegimeFlow from Python notebooks or scripts Python Overview
Inspect live brokers and operational boundaries Live Overview
Consume RegimeFlow from a separate CMake project Quick Install
Contribute code or plugins https://github.com/gregorian-09/regime-flow/blob/main/CONTRIBUTING.md

Python-first research users

  1. Quick Install
  2. Python Overview
  3. Python Workflow
  4. Python Usage

Source-build users

  1. Installation
  2. Quickstart (Backtest)
  3. Backtesting
  4. Configuration

Live-trading users

  1. Installation
  2. Live Overview
  3. Brokers
  4. Production Readiness

CMake and packaging consumers

  1. Quick Install
  2. Installation
  3. Configuration

Support Tiers

Path Support level Notes
Python wheels Recommended Fastest path for backtests and Python research.
Source build Recommended Full engine, tests, plugins, and optional integrations.
vcpkg overlay/custom registry Supported Best path for external CMake consumers.
Linux .deb / .rpm artifacts Release artifact Suitable for deployment installs; tied to release packaging quality.
Homebrew Experimental Verify the formula version before relying on it.

Before You Go Further

  • Installation is the source of truth for prerequisites, feature flags, and supported platforms.
  • Troubleshooting covers common build, wheel, and environment problems.
  • Project Layout explains the repo shape once you know which path you are on.