Skip to content

Installation

Prerequisites

  • Linux (Ubuntu 22.04+ recommended)
  • Python 3.12+
  • Docker 24+ — required for all solvers
  • NVIDIA GPU + Container Toolkit — optional, for XLB solver and DoMINO NIM

Docker is required

All solvers run in Docker containers. Install Docker Engine and ensure your user is in the docker group: sudo usermod -aG docker $USER.

Install

pip install arxyne

Or from source:

git clone https://github.com/arxynehq/arxyne && cd arxyne
python3.12 -m venv arxyne-env && source arxyne-env/bin/activate
pip install -e .

Verify

arxyne --version
arxyne --list

--list should show the bundled products: ahmed, onera-m6, drivaer-notchback.

Solver Images

Solver images pull automatically on first use. No manual setup needed — just run a solve and Arxyne handles the rest:

arxyne --product ahmed --aero --solver openfoam

🔧 For developers: arxyne --pull <solver> pulls the latest solver image from GHCR. For local dev builds, use docker build directly from solvers/<solver>/.

DoMINO NIM (AI surrogate) requires an NGC account and NVIDIA GPU (≥ 8 GB VRAM). Pull the image separately:

docker pull nvcr.io/nim/nvidia/domino-automotive-aero:2.1.0

Check

arxyne --doctor

Green across the board means you're ready to simulate.