Tick Backtest¶
Welcome to the user documentation for Tick Backtest. This site explains how to install the package, run tick-level FX backtests, configure strategies and metrics, and interpret the generated artefacts.
What You Can Do¶
- Run deterministic tick-level FX backtests from YAML configuration files.
- Combine compiled tick feeds, rolling indicators, and predicate-driven entry rules.
- Produce reproducible manifests, NDJSON logs, and trade-level analytics for every run.
- Generate post-run reports, equity curves, and metric stratification studies.
How to Navigate¶
- New users should start with the Quickstart to install the package and execute the packaged demo project.
- Use Configuration as a reference when editing backtest, metrics, or strategy YAML.
- Analysis & Reporting walks through the outputs written under the configured
output_base_path/<RUN_ID>/. - Developers can explore Architecture for a deeper look at the runtime flow and resilience features.
- Advanced implementation notes live under Developer Notes; these are optional for end users.
Getting Help¶
If you run into issues, review the troubleshooting sections embedded throughout the documentation or open a GitHub issue with run logs and manifests.