setup_backtest

setup_backtest(strategy_path, start_at=None, end_at=None, initial_deposit=None, max_slippage=0.01, cycle_duration=None, candle_time_frame=None, strategy_module=None, name=None, minimum_data_lookback_range=None)

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:

• max_slippage (Optional[float]) – Legacy

• cycle_duration (Optional[CycleDuration]) – Override the default strategy cycle duration

• candle_time_frame (Optional[TimeBucket]) – Override the default strategy candle time bucket

• strategy_module (Optional[StrategyModuleInformation]) – If strategy module was previously loaded

• strategy_path (Path) –

• start_at (Optional[datetime]) –

• end_at (Optional[datetime]) –

• initial_deposit (Optional[float]) –

• name (Optional[str]) –

• minimum_data_lookback_range (Optional[timedelta]) –

Return type:

BacktestSetup