Installation

NautilusTrader is tested and supported for Python 3.10-3.12 on the following 64-bit platforms:

Operating System	Supported Versions	CPU Architecture
Linux (Ubuntu)	20.04 or later	x86_64
macOS	14 or later	ARM64
Windows Server	2022 or later	x86_64

tip

We recommend running the platform with the latest stable version of Python, and in a virtual environment to isolate the dependencies.

From PyPI

To install the latest 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)
• docker: Needed for Docker when using the IB gateway (with the Interactive Brokers adapter)
• ib: Interactive Brokers adapter

To install with specific extras using pip:

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

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 https://pyo3.rs/latest/getting_started#virtualenvs.

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