Skip to content

Installation Guide

Prerequisites

Before installing AKQuant, please ensure your system meets the following requirements:

  • Python: Version >= 3.10.
  • Rust: If compiling from source, install the latest stable version of Rust. Install Rust
  • OS: macOS, Linux, Windows.

Installation Methods

AKQuant is now available on PyPI. You can install the pre-compiled wheel (no Rust required) via:

pip install akquant

Install optional features as needed; they can be combined, e.g. pip install "akquant[mcp,ml]":

Extra Contents
mcp MCP server (MCP SDK), so AI assistants can look up APIs, write strategies and run backtests; see MCP Server
ml Machine learning: scikit-learn, PyTorch
quantstats QuantStats performance reports
signal-redis Redis Stream source for external signal ingestion
full Everything in ml and quantstats (not mcp)

To use AKQuant only from an AI assistant you don't need to install it: connect with uvx as described in MCP Server and the client downloads and starts it.

2. Install from Source (Development Mode)

If you wish to contribute to development or use the latest features, you can install from source.

First, clone the repository:

git clone https://github.com/yourusername/akquant.git
cd akquant

Create and activate a virtual environment (optional but recommended):

python3 -m venv .venv
source .venv/bin/activate  # macOS/Linux
# .venv\Scripts\activate   # Windows

Install the build tool maturin:

pip install maturin

Build and install into the current environment:

maturin develop

Or build a release version (for optimized performance):

maturin develop --release

Verify Installation

After installation, you can import akquant in Python to verify:

import akquant
print(akquant.__version__)

If no errors occur, the installation was successful.