# shner-elmo/backtester-rs architecture

> Architecture diagram of the GitHub repository shner-elmo/backtester-rs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shner-elmo/backtester-rs
- Repository: https://github.com/shner-elmo/backtester-rs

## Overview

backtester-rs is an event-driven US-equity backtesting engine, with companion chart-exploration and results-dashboard applications. The main workflow is: an engineer supplies an Algorithm, configures its run through Context, and the engine processes market data, executes orders, and produces performance results for inspection. The graph preserves documented metadata, modeling, visualization, and reporting capabilities. Some internal runtime wiring is not shown in the excerpts; those connections are omitted rather than inferred.

Main entry points: [`backtester/src/engine/run.rs`](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/run.rs) (Event Loop), [`backtester/src/context.rs`](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/context.rs) (Run Context), [`backtester/src/data.rs`](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/data.rs) (Dataset Reader), [`backtester/src/algorithm.rs`](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/algorithm.rs) (Algorithm)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_strategy["Strategy API"]
  node_strategy["Algorithm<br/>[algorithm.rs]"]
  node_context["Run Context<br/>[context.rs]"]
  node_consolidator["Bar Consolidators<br/>[consolidator.rs]"]
  node_indicators["Indicators<br/>[indicators.rs]"]
  node_insider["Insider Data<br/>[insider.rs]"]
end

subgraph group_marketdata["Market Data"]
  node_dataset[("Parquet Dataset")]
  node_data["Dataset Reader<br/>[data.rs]"]
  node_tickstream["Ordered Tick Stream<br/>[tick_stream.rs]"]
  node_symbol["Ticker Mapping<br/>[symbol.rs]"]
  node_bars["Market Bars<br/>[bar.rs]"]
end

subgraph group_engine["Backtest Engine"]
  node_engine["Event Loop<br/>[run.rs]"]
  node_orders["Order Execution<br/>[orders.rs]"]
  node_corporate["Corporate Actions"]
  node_ledger["Trade Ledger<br/>[ledger.rs]"]
  node_broker["Portfolio State<br/>[broker.rs]"]
  node_slippage["Slippage Models<br/>[slippage.rs]"]
  node_commission["Commission Models<br/>[commission.rs]"]
  node_margin["Buying Power Models<br/>[margin.rs]"]
end

subgraph group_results["Results and Reporting"]
  node_stats["Performance Statistics<br/>[stats.rs]"]
  node_result["Backtest Result<br/>[mod.rs]"]
  node_ui["Results Dashboard<br/>[main.rs]"]
end

subgraph group_exploration["Data Exploration"]
  node_viz["OHLCV Explorer<br/>[lib.rs]"]
  node_vizstrategy["Explorer Strategy<br/>[viz_strategy.rs]"]
  node_vizmain["Explorer App<br/>[main.rs]"]
end

node_engineer(("Strategy Author"))

node_engineer -->|"implements"| node_strategy
node_engineer -->|"configures"| node_context
node_strategy -->|"configures run"| node_context
node_strategy -->|"runs backtest"| node_engine
node_context -.->|"loads optionally"| node_insider
node_dataset -->|"reads files"| node_data
node_data -->|"resolves tickers"| node_symbol
node_data -->|"decodes bars"| node_bars
node_tickstream -->|"uses reader"| node_data
node_engine -.->|"streams ticks"| node_tickstream
node_engine -->|"feeds bars"| node_consolidator
node_engine -->|"delegates execution"| node_orders
node_engine -->|"delegates actions"| node_corporate
node_engine -->|"delegates accounting"| node_ledger
node_orders -->|"updates ledger"| node_ledger
node_context -->|"configures model"| node_slippage
node_context -->|"configures model"| node_commission
node_context -->|"configures model"| node_margin
node_engine -->|"computes statistics"| node_stats
node_engine -->|"assembles result"| node_result
node_result -->|"displays result files"| node_ui
node_dataset -->|"shares data root"| node_viz
node_vizmain -->|"starts explorer"| node_viz
node_viz -->|"uses strategy"| node_vizstrategy

click node_strategy "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/algorithm.rs"
click node_context "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/context.rs"
click node_consolidator "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/consolidator.rs"
click node_indicators "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/indicators.rs"
click node_insider "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/insider.rs"
click node_data "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/data.rs"
click node_tickstream "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/tick_stream.rs"
click node_symbol "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/symbol.rs"
click node_bars "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/bar.rs"
click node_engine "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/run.rs"
click node_orders "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/orders.rs"
click node_corporate "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/corporate_actions.rs"
click node_ledger "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/ledger.rs"
click node_broker "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/broker.rs"
click node_slippage "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/slippage.rs"
click node_commission "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/commission.rs"
click node_margin "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/margin.rs"
click node_stats "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/stats.rs"
click node_result "https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/mod.rs"
click node_ui "https://github.com/shner-elmo/backtester-rs/blob/master/ui/src/main.rs"
click node_viz "https://github.com/shner-elmo/backtester-rs/blob/master/data-viz/src/lib.rs"
click node_vizstrategy "https://github.com/shner-elmo/backtester-rs/blob/master/data-viz/src/viz_strategy.rs"
click node_vizmain "https://github.com/shner-elmo/backtester-rs/blob/master/data-viz/src/main.rs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_strategy,node_context,node_consolidator,node_indicators,node_insider toneBlue
class node_dataset,node_data,node_tickstream,node_symbol,node_bars toneAmber
class node_engine,node_orders,node_corporate,node_ledger,node_broker,node_slippage,node_commission,node_margin toneMint
class node_stats,node_result,node_ui toneRose
class node_viz,node_vizstrategy,node_vizmain,node_engineer toneIndigo
```

## Components

### Strategy API

- [Algorithm](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/algorithm.rs): `backtester/src/algorithm.rs`
- [Run Context](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/context.rs): `backtester/src/context.rs`
- [Bar Consolidators](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/consolidator.rs): `backtester/src/consolidator.rs`
- [Indicators](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/indicators.rs): `backtester/src/indicators.rs`
- [Insider Data](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/insider.rs): `backtester/src/insider.rs`

### Market Data

- **Parquet Dataset**
- [Dataset Reader](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/data.rs): `backtester/src/data.rs`
- [Ordered Tick Stream](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/tick_stream.rs): `backtester/src/tick_stream.rs`
- [Ticker Mapping](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/symbol.rs): `backtester/src/symbol.rs`
- [Market Bars](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/bar.rs): `backtester/src/bar.rs`

### Backtest Engine

- [Event Loop](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/run.rs): `backtester/src/engine/run.rs`
- [Order Execution](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/orders.rs): `backtester/src/engine/orders.rs`
- [Corporate Actions](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/corporate_actions.rs): `backtester/src/engine/corporate_actions.rs`
- [Trade Ledger](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/ledger.rs): `backtester/src/engine/ledger.rs`
- [Portfolio State](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/broker.rs): `backtester/src/broker.rs`
- [Slippage Models](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/slippage.rs): `backtester/src/slippage.rs`
- [Commission Models](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/commission.rs): `backtester/src/commission.rs`
- [Buying Power Models](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/margin.rs): `backtester/src/margin.rs`

### Results and Reporting

- [Performance Statistics](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/stats.rs): `backtester/src/stats.rs`
- [Backtest Result](https://github.com/shner-elmo/backtester-rs/blob/master/backtester/src/engine/mod.rs): `backtester/src/engine/mod.rs`
- [Results Dashboard](https://github.com/shner-elmo/backtester-rs/blob/master/ui/src/main.rs): `ui/src/main.rs`

### Data Exploration

- [OHLCV Explorer](https://github.com/shner-elmo/backtester-rs/blob/master/data-viz/src/lib.rs): `data-viz/src/lib.rs`
- [Explorer Strategy](https://github.com/shner-elmo/backtester-rs/blob/master/data-viz/src/viz_strategy.rs): `data-viz/src/viz_strategy.rs`
- [Explorer App](https://github.com/shner-elmo/backtester-rs/blob/master/data-viz/src/main.rs): `data-viz/src/main.rs`

### Other components

- **Strategy Author**

## Connections

- Strategy Author → Algorithm: implements (evidence: `README.md`)
- Strategy Author → Run Context: configures (evidence: `README.md`)
- Algorithm → Run Context: configures run (evidence: `README.md`)
- Algorithm → Event Loop: runs backtest (evidence: `README.md`)
- Run Context → Insider Data: loads optionally (evidence: `backtester/src/insider.rs`)
- Parquet Dataset → Dataset Reader: reads files (evidence: `README.md`)
- Dataset Reader → Ticker Mapping: resolves tickers (evidence: `backtester/src/data.rs`)
- Dataset Reader → Market Bars: decodes bars (evidence: `backtester/src/data.rs`)
- Ordered Tick Stream → Dataset Reader: uses reader (evidence: `backtester/src/tick_stream.rs`)
- Event Loop → Ordered Tick Stream: streams ticks
- Event Loop → Bar Consolidators: feeds bars (evidence: `backtester/src/engine/run.rs`)
- Event Loop → Order Execution: delegates execution (evidence: `backtester/src/engine/mod.rs`)
- Event Loop → Corporate Actions: delegates actions (evidence: `backtester/src/engine/mod.rs`)
- Event Loop → Trade Ledger: delegates accounting (evidence: `backtester/src/engine/mod.rs`)
- Order Execution → Trade Ledger: updates ledger (evidence: `backtester/src/engine/orders.rs`)
- Run Context → Slippage Models: configures model (evidence: `backtester/src/context.rs`)
- Run Context → Commission Models: configures model (evidence: `backtester/src/context.rs`)
- Run Context → Buying Power Models: configures model (evidence: `backtester/src/context.rs`)
- Event Loop → Performance Statistics: computes statistics (evidence: `backtester/src/engine/run.rs`)
- Event Loop → Backtest Result: assembles result (evidence: `backtester/src/engine/run.rs`)
- Backtest Result → Results Dashboard: displays result files (evidence: `README.md`)
- Parquet Dataset → OHLCV Explorer: shares data root (evidence: `README.md`)
- Explorer App → OHLCV Explorer: starts explorer (evidence: `data-viz/src/main.rs`)
- OHLCV Explorer → Explorer Strategy: uses strategy (evidence: `data-viz/src/lib.rs`)
