Skip to content

run-experiment

command run-experiment

Run a backtest experiment defined in a configuration file.

Reads an experiment configuration from a .toml, .yaml/.yml or .json file, executes the full backtest pipeline — data resolution, indicator computation, parallel strategy runs — and persists the results to the local database. The outcome can then be explored interactively via backtide launch.

Read more in the user guide.

Parameters

config : Path

Path to the experiment configuration (.toml, .yaml/.yml or .json).

--log_level, -l : str, default="warn"
Minimum log level to emit. Choose from: error``,warn,infoordebug`.

--verbose/--no-verbose, -v : bool, default=True
Whether to display a progress bar while the experiment is running.


See Also

ExperimentResult

The complete result of a single experiment.

launch

Launch the Backtide UI in a local web browser.

run_experiment

Run a backtest experiment with the provided configuration.


Example

Run an experiment from a TOML config file: 

backtide run-experiment experiment.toml