Quickstart¶

Use this page for a 5-minute first run.

Recommended Path

Start with editable install so local examples and docs stay in sync with your checkout.

1) Install¶

Editable (recommended)Package only

pip install -e .
pip install -r requirements-dev.txt

pip install stacksats

2) Run the example strategy¶

python examples/model_example.py

This runs validation and backtest, then writes artifacts to output/.

3) Use the Strategy Lifecycle CLI¶

stacksats strategy validate --strategy examples/model_example.py:ExampleMVRVStrategy
stacksats strategy backtest --strategy examples/model_example.py:ExampleMVRVStrategy --output-dir output
stacksats strategy export --strategy examples/model_example.py:ExampleMVRVStrategy --output-dir output

4) Inspect outputs¶

Primary run artifacts are written under:

output/<strategy_id>/<version>/<run_id>/