Installation

NautilusTrader is officially supported for Python 3.11 and 3.12 for the following 64-bit platforms:

Operating System	Supported Versions	CPU Architecture
Linux (Ubuntu)	22.04 and later	x86_64
macOS	14.7 and later	ARM64
Windows Server	2022 and later	x86_64

note

NautilusTrader may work on other platforms, but only those listed above are regularly used by developers and tested in CI.

tip

We recommend using the latest supported version of Python and setting up nautilus_trader in a virtual environment to isolate dependencies.

From PyPI

To install the latest nautilus_trader binary wheel (or sdist package) from PyPI using Pythons pip package manager:

pip install -U nautilus_trader

Extras

Install optional dependencies as 'extras' for specific integrations:

• betfair: Betfair adapter (integration) dependencies.
• docker: Needed for Docker when using the IB gateway (with the Interactive Brokers adapter).
• dydx: dYdX adapter (integration) dependencies.
• ib: Interactive Brokers adapter (integration) dependencies.
• polymarket: Polymarket adapter (integration) dependencies.

To install with specific extras using pip:

pip install -U "nautilus_trader[docker,ib]"

From the Nautech Systems package index

The Nautech Systems package index (packages.nautechsystems.io) is PEP-503 compliant and hosts both stable and development binary wheels for nautilus_trader. This enables users to install either the latest stable release or pre-release versions for testing.

Stable wheels

Stable wheels correspond to official releases of nautilus_trader on PyPI, and use standard versioning.

To install the latest stable release:

pip install -U nautilus_trader --index-url=https://packages.nautechsystems.io/simple

Development wheels

Development wheels are published from both the develop and nightly branches for Linux and macOS, allowing users to test features and fixes ahead of stable releases.

This process also helps preserve compute resources and ensures easy access to the exact binaries tested in CI pipelines, while adhering to PEP-440 versioning standards:

• develop wheels use the version format dev{date}+{build_number} (e.g., 1.208.0.dev20241212+7001).
• nightly wheels use the version format a{date} (alpha) (e.g., 1.208.0a20241212).

warning

We don't recommend using development wheels in production environments, such as live trading controlling real capital.

Installation commands

By default, pip installs the latest stable release. Adding the --pre flag ensures that pre-release versions, including development wheels, are considered.

To install the latest available pre-release (including development wheels):

pip install -U nautilus_trader --pre --index-url=https://packages.nautechsystems.io/simple

To install a specific development wheel (e.g., 1.208.0a20241212 for December 12, 2024):

pip install nautilus_trader==1.208.0a20241212 --index-url=https://packages.nautechsystems.io/simple

Available versions

You can view all available versions of nautilus_trader on the package index.

To programmatically fetch and list available versions:

curl -s https://packages.nautechsystems.io/simple/nautilus-trader/index.html | grep -oP '(?<=<a href=")[^"]+(?=")' | awk -F'#' '{print $1}' | sort

Branch updates

• develop branch wheels (.dev): Are built and published continuously with every merged commit.
• nightly branch wheels (a): Are built and published daily when develop branch is automatically merged at 14:00 UTC (if there are changes).

Retention policies

• develop branch wheels (.dev): Only the most recent wheel build is retained.
• nightly branch wheels (a): Only the 3 most recent wheel builds are retained.

From Source

Installation from source requires the Python.h header file, which is included in development releases such as python-dev. You'll also need the latest stable rustc and cargo to compile the Rust libraries.

For MacBook Pro M1/M2, make sure your Python installed using pyenv is configured with --enable-shared:

PYTHON_CONFIGURE_OPTS="--enable-shared" pyenv install <python_version>

See the PyO3 user guide for more details.

It's possible to install from source using pip if you first install the build dependencies as specified in the pyproject.toml. We highly recommend installing using poetry as below.

1. Install rustup (the Rust toolchain installer):

   • Linux and macOS:

     curl https://sh.rustup.rs -sSf | sh
   • Windows:
     • Download and install rustup-init.exe
     • Install "Desktop development with C++" with Build Tools for Visual Studio 2019
   • Verify (any system): from a terminal session run: rustc --version

2. Enable cargo in the current shell:

   • Linux and macOS:

     source $HOME/.cargo/env
   • Windows:
     • Start a new PowerShell

3. Install clang (a C language frontend for LLVM):

   • Linux:

     sudo apt-get install clang
   • Windows:
     1. Add Clang to your Build Tools for Visual Studio 2019:
        • Start | Visual Studio Installer | Modify | C++ Clang tools for Windows (12.0.0 - x64…) = checked | Modify
     2. Enable clang in the current shell:

        [System.Environment]::SetEnvironmentVariable('path', "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Tools\Llvm\x64\bin\;" + $env:Path,"User")
   • Verify (any system): from a terminal session run: clang --version

4. Install poetry (or follow the installation guide on their site):

   curl -sSL https://install.python-poetry.org | python3 -

5. Clone the source with git, and install from the projects root directory:

   git clone https://github.com/nautechsystems/nautilus_trader
   cd nautilus_trader
   poetry install --only main --all-extras

From GitHub Release

To install a binary wheel from GitHub, first navigate to the latest release. Download the appropriate .whl for your operating system and Python version, then run:

pip install <file-name>.whl

Versioning and releases

NautilusTrader is still under active development. Some features may be incomplete, and while the API is becoming more stable, breaking changes can occur between releases. We strive to document these changes in the release notes on a best-effort basis.

We aim to follow a weekly release schedule, though experimental or larger features may cause delays.

Use NautilusTrader only if you are prepared to adapt to these changes.

Redis

Using Redis with NautilusTrader is optional and only required if configured as the backend for a cache database or message bus.

info

The minimum supported Redis version is 6.2 or higher (required for streams functionality).

For a quick setup, we recommend using a Redis Docker container. You can find an example setup in the .docker directory, or run the following command to start a container:

docker run -d --name redis -p 6379:6379 redis:latest

This command will:

• Pull the latest version of Redis from Docker Hub if it's not already downloaded.
• Run the container in detached mode (-d).
• Name the container redis for easy reference.
• Expose Redis on the default port 6379, making it accessible to NautilusTrader on your machine.

To manage the Redis container:

• Start it with docker start redis
• Stop it with docker stop redis

tip

We recommend using Redis Insight as a GUI to visualize and debug Redis data efficiently.