Skip to content


This guide will help you to set up a Windows workstation to work with the code and develop Opteryx.

If using WSL, refer to the Debian/Ubuntu set up guide. Initial set up of the WSL component is not covered in these guides.

Intel/x86 is the recommended environment, it has not been confirmed that Opteryx operates as expected on ARM Windows - it does operate on Linux and Mac ARM.

Setting Up

1. Install Python

3.11 recommended

We recommend using pyenv to install and manage Python environments, particularly in development and test environments.

2. Install pip

> python -m ensurepip --upgrade

3. Install Git

Follow the instructions at

4. Install Rust

Follow the instructions at

5. Clone the Repository

> clone

5. Install Dependencies

> python -m pip install --upgrade -r requirements.txt
> python -m pip install --upgrade setuptools setuptools_rust numpy cython

6. Build Binaries

> python build_ext --inplace

Running Tests

To run the regression and unit tests:

First, install the optional dependencies:

> python -m pip install --upgrade -r tests/requirements.txt

Then run the regression tests.

> python -m pytest


Some tests require external services like GCS and Memcached and may fail if these have not been configured.