setup_backtest#
- setup_backtest(strategy_path, start_at, end_at, initial_deposit, max_slippage=0.01, cycle_duration=None, candle_time_frame=None)[source]#
High-level entry point for setting up a backtest from a strategy module.
This function is useful for running backtests for strategies in notebooks and tests.
- Parameters:
cycle_duration (Optional[CycleDuration]) – Override the default strategy cycle duration
candle_time_frame (Optional[TimeBucket]) – Override the default strategy candle time bucket
strategy_path (Path) –
start_at (datetime) –
end_at (datetime) –
initial_deposit (int) –