Skip to content

installation.md

Latest commit

 

History

History
56 lines (38 loc) · 970 Bytes

installation.md

File metadata and controls

56 lines (38 loc) · 970 Bytes
Raw

Installation

Requirements

  • Python 3.12 or higher
  • Polars
  • PyYAML
  • NumPy

Install from PyPI

pip install ml4t-backtest

Or with uv:

uv add ml4t-backtest

Install from Source

git clone https://github.com/ml4t/backtest.git
cd backtest
pip install -e .

Verify Installation

from ml4t.backtest import Engine, Strategy, DataFeed, BacktestConfig, run_backtest
from ml4t.backtest import StopLoss, TakeProfit, TrailingStop, RuleChain

print("ml4t-backtest installed successfully")

Optional Dependencies

Trading calendars for session enforcement (skip weekends/holidays):

pip install pandas-market-calendars

ml4t-diagnostic for post-backtest analysis (tearsheets, trade analytics):

pip install ml4t-diagnostic

Next Steps