Skip to content

Installation

alpha-visualizer is published on PyPI and requires Python 3.12+.

Pair with alpha-forge

alpha-visualizer installs and runs independently of forge (the backtest engine), but the backtest_results.db it visualizes is produced by forge. If you haven't installed it yet, see the AlphaForge Getting Started guide (latest binaries are also on GitHub Releases).

Requirements

Item Version
Python 3.12 or later
OS macOS / Linux / Windows
Browser Latest Chrome / Firefox / Safari / Edge

uv installs the tool into an isolated environment, sidestepping Python version conflicts.

uv tool install alpha-visualizer

If you don't have uv yet, see https://docs.astral.sh/uv/getting-started/installation/.

pip

Plain Python installation:

pip install alpha-visualizer

Inside a virtualenv:

python -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install alpha-visualizer

From source (for development)

Clone the repo and run locally:

git clone https://github.com/alforge-labs/alpha-visualizer.git
cd alpha-visualizer
uv sync                            # Python deps
cd frontend && pnpm install && pnpm run build && cd ..
uv run vis serve --forge-dir <path>

See CONTRIBUTING.en.md for the full development workflow.

Verify the install

vis --version

A correctly installed vis prints its version.

Upgrade

# uv
uv tool upgrade alpha-visualizer

# pip
pip install --upgrade alpha-visualizer

Uninstall

# uv
uv tool uninstall alpha-visualizer

# pip
pip uninstall alpha-visualizer

Next steps