Skip to content

Quickstart

Use this page when you want the canonical first-run path for StackSats as a package user.

1) Choose your install mode

Use case Install mode Command
I want to use StackSats package install pip install stacksats
I am working from a checkout editable install python -m pip install -c requirements/constraints-maintainer.txt -e ".[dev,all]"

Recommended first run:

pip install stacksats

If you are working from this repository checkout instead:

python -m venv venv
source venv/bin/activate
venv/bin/python -m pip install --upgrade pip
venv/bin/python -m pip install -c requirements/constraints-maintainer.txt -e ".[dev,all]"

For plotting or animation commands later, install visual extras:

pip install "stacksats[viz]"

2) Run the packaged demo

stacksats demo backtest

Optional demo lifecycle commands:

stacksats demo validate
stacksats demo export

This runs a packaged example through the canonical lifecycle and writes artifacts under:

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

3) Use the full strategy lifecycle CLI

After the demo succeeds, move to the full strategy and data command families.

Use these pages next:

4) Inspect outputs

Primary run artifacts are written under:

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

Typical files:

  • backtest_result.json
  • metrics.json
  • plot .svg files

Success Criteria

A successful quickstart run should produce all of the following:

  • CLI command exits without traceback.
  • Backtest summary is printed.
  • Backtest artifacts are written under one run directory.

Troubleshooting

  • If command import fails, confirm you installed either the package or the editable checkout from repo root.
  • If you want the canonical BRK workflow next, use Full Data Setup.
  • If dates or outputs look wrong, run explicit lifecycle commands from CLI Commands.
  • If upgrading and old helper names fail, use Migration Guide.
  • If you need minimal copy-paste templates, use Minimal Strategy Examples.

Feedback