Installation

Introduction¶

Roboquant can be installed like most other Python packages. It is being published on PyPI and below you’ll find instructions for various installation methods and scenarios.

Prerequisites¶

• Python 3.12 or higher — roboquant uses modern Python features and does not support older versions.

• A virtual environment is recommended to keep dependencies isolated.

Install with pip¶

The simplest way to install roboquant is via pip:

pip install --upgrade roboquant

This installs the core package with a minimal set of dependencies.

Optional Dependencies¶

The core installation keeps the dependency footprint small. If you need specific functionality, install roboquant with one or more of the following optional dependencies:

To install roboquant with all optional dependencies at once:

pip install --upgrade "roboquant[ai,extra]"

Install with uv¶

uv is a fast Python package and project manager. It is also the package manager used to develop roboquant. It is highly recommended to check it out if you didn’t do so already.

If you are using uv, starting a new project from scratch is straightforward:

mkdir my-project
cd my-project
uv init
uv add roboquant
uv run python -c "import roboquant;roboquant.info()"

Or with all the extras:

uv add "roboquant[ai,extra]"

Install from Source¶

To install the latest development version directly from the GitHub repository:

pip install git+https://github.com/neurallayer/roboquant.py.git

Or clone the repository and install locally. This assumes you already have uv installed since that is used for the build process.

git clone https://github.com/neurallayer/roboquant.py.git
cd roboquant.py
./bin/local_install.sh

Verify Installation¶

To confirm that roboquant was installed correctly, run the following in a Python shell:

import roboquant as rq
rq.info()

             _______
            | $   $ |         Roboquant v2.9.5.dev1
            |   o   |         Python v3.12.3
            |_[___]_|         Linux v6.17.0-1022-azure
        ___ ___|_|___ ___
       ()___)       ()___)
      /  / |         | \  \
     (___) |_________| (___)
      | |   __/___\__   | |
      /_\  |_________|  /_\
     // \\  |||   |||  // \\
     \\ //  |||   |||  \\ //
           ()__) ()__)
           ///     \\\
        __///_     _\\\__
       |______|   |______|

You should see the installed version printed.

You can also run a quick smoke test:

import roboquant as rq
account = rq.demo_run()
print(account)

buying power : 390,904@USD
cash         : 390,904@USD
equity       : 2,046,038@USD
positions    : 922@GOOGL, 687@AAPL, 1602@XOM, 653@JPM, 436@TSLA, 292@META, 1020@NVDA, 840@AMZN
trades       : 296
mkt value    : 1,655,134@USD
orders       : none
last update  : 2025-12-31 05:00:00+00:00

If this runs without errors, your installation is ready to use.