Skip to content

Installation

GPRMax UI is a Python package, but simulations require a working gprMax installation. Install and validate gprMax first, then install gprmaxui into the same environment.

Requirements

  • Python 3.10 or newer.
  • gprMax available in the active Python environment.
  • Optional CUDA and PyCUDA support when using gprMax GPU execution.

Install GPRMax UI

The current documented release is 1.0.3.

1
pip install gprmaxui

The base install keeps visualization libraries out of the default dependency set. Install the optional extras for plotting, PyVista geometry rendering, and MP4 export:

1
pip install "gprmaxui[viz,video]"

For development from a local checkout:

1
2
uv sync --group dev
uv run --group dev python -c "import gprmaxui; print(gprmaxui.__version__)"

Install gprMax

Follow the official gprMax installation guide for your platform. A source-based development install typically follows this shape:

1
2
3
4
git clone https://github.com/gprMax/gprMax.git
cd gprMax
python setup.py build
python setup.py develop --no-deps

Linux systems may also need OpenMP runtime packages such as libgomp1 or libomp-dev, depending on the compiler and distribution.

Optional GPU Support

GPU execution is handled by gprMax. When CUDA and PyCUDA are available, install the optional package extra:

1
pip install "gprmaxui[gpu]"

For local development with uv:

1
uv sync --group dev --extra gpu

Build These Docs

The repository uses mkdocs/ as the editable Markdown source and docs/ as the generated site output:

1
2
uv run --group dev mkdocs build --strict
uv run --group dev mkdocs serve -a localhost:8000