Installation

Installation

Requirements

• Python 3.10 or newer
• tkinter for the GUI (usually pre-installed; see below if missing)
• No other runtime dependencies

pip (recommended)

pip install natbench
natbench --help
natbench-gui          # opens the graphical interface

Pre-built binaries

Download from Releases:

File	Platform
natbench-linux-x86_64	Linux (x86-64)
natbench-gui-linux-x86_64	Linux GUI
natbench-windows-x86_64.exe	Windows
natbench-gui-windows-x86_64.exe	Windows GUI
natbench-macos-arm64	macOS (Apple Silicon)

Make executable and run:

chmod +x natbench-linux-x86_64
./natbench-linux-x86_64 --top 5

From source

git clone https://github.com/natural78/natbench.git
cd natbench
pip install -e .
natbench --top 5

Installing tkinter (GUI only)

If natbench-gui exits with a tkinter error:

Distro	Command
Arch / CachyOS	sudo pacman -S tk
Debian / Ubuntu	sudo apt install python3-tk
Fedora	sudo dnf install python3-tkinter
macOS (Homebrew)	brew install python-tk

Verify install

natbench --version
# NatBench 1.1.0

Settings location

User settings are stored in ~/.config/natbench/settings.json.
History from the last run: ~/.config/natbench/history.json.