Docs / Getting started
RealBuild from source
No package is published. The engine builds from source with Rust's own tools.
Today
There is no package and no install command. The commands below run from a checkout of the source repository.
cd fth-engine cargo test # full suite cargo run --example ema_cross # example backtest on synthetic data cargo run --release --example breakout_bracket -- --html tearsheet.html cargo run --release --bin fth-catalog -- <root> verify
Requirements
- Rust 1.88 or later, the minimum the data catalog's dependencies need. CI uses Rust 1.93.0.
- On a Windows machine with a small paging file,
cargo test -j 2completes reliably; building many test binaries in parallel can run out of commit memory.
Dependencies
Every dependency is pinned to an exact version and the lockfile is committed. Each one added so far is recorded with its reason in a decision record or a founder flag.
Planned for a first release
- A Rust crate for pure-Rust strategies
- A Python package, once the Python layer exists (it is proposed, not built)
- Signed provenance and a software bill of materials on every release
- A changelog entry and honest status labels