Skip to content

Installation

Coming soon

zeki's first release isn't on PyPI yet: the zeki package there is a placeholder holding the name. The commands below will install zeki once it's released.

Install zeki from PyPI with pip or uv:

pip install zeki
uv add zeki

zeki needs Python 3.9 or later, and brings NumPy and Polars with it. To read values out as pandas objects, install pandas too.

Platforms

Wheels are built for:

Platform Architectures
Linux (manylinux) x86-64, ARM64
macOS Intel, Apple silicon
Windows x86-64

One wheel covers every supported Python version.

On x86-64, the wheel holds two builds of the engine: one that runs on any x86-64 processor from about 2009, and a faster one for processors with AVX2 and FMA (Intel from 2013, AMD from 2015). zeki loads the faster build when your processor supports it. You don't need to do anything.

Check it works

import zeki as zk

print(zk.num_threads())  # the threads zeki evaluates on: by default, one per logical processor

zeki uses every logical processor by default, and releases the GIL while it evaluates, so other Python threads keep running. To use fewer, call zk.set_num_threads(n) before the first evaluation: the thread pool is set up once per process.