voxelerate 0.5.7.post2

GPU mesh visualizer, voxelizer, and spatial-structure toolkit for 3D triangle meshes.

Voxelerate

Voxelerate is a GPU-accelerated toolkit for loading, visualizing, voxelizing, and serializing 3D triangle meshes.
It is designed for workflows where a mesh must be inspected in 3D, converted into a dense voxel volume, optionally accelerated with BVH or octree structures, and saved for reuse in later pipelines such as volumetric 3D printing, simulation, geometry processing, or analysis.

Gallery

3D viewer: mesh, voxel grid, BVH, and octree

Central slice inspection with voxel-octree overlay

Overview

Voxelerate is built around a practical geometry workflow:

• load OBJ and STL meshes
• inspect meshes in a real-time GPU viewer
• voxelize with surface or solid modes
• work from either automatic bounds or an explicit external grid
• build and reuse BVH and octree hierarchies
• inspect voxel data with clean 2D slice visualizations
• save voxel grids and spatial structures for later use

A core design rule in Voxelerate is that viewer interaction is preview-only. Camera and preview transforms in the window never change the geometry that gets voxelized. The only transforms that affect voxelization are the ones you pass explicitly as inputs.

Highlights

• Mesh I/O for OBJ and STL
• GPU viewer for meshes, voxel grids, BVHs, and octrees
• GPU voxelization using OpenGL compute shaders
• Surface and solid voxelization modes
• Automatic or explicit voxelization grids
• BVH with median and SAH splitting
• Mesh octree and voxel octree generation
• Pickle and NPZ serialization
• 2D slice plots with optional hierarchy overlays
• Reusable saved hierarchies for expensive large-mesh preprocessing

Installation

Install from PyPI (recommended):

pip install voxelerate

On Windows, the equivalent command is:

py -m pip install voxelerate

Optional extras:

pip install "voxelerate[open3d]"
pip install "voxelerate[dev]"

Install from the repository source:

pip install -r requirements.txt

Editable source install:

pip install -e .

If the voxelerate command is not recognized on Windows after installation, add your Python Scripts directory to PATH.

Runtime requirements

Voxelerate uses desktop OpenGL through GLFW and PyOpenGL.

• Viewer: OpenGL 3.3+
• Voxelizer: OpenGL 4.3+ for compute shaders

Core conventions

These conventions are explicit throughout the repository.

• world-space vectors use (x, y, z)
• grid sizes use (x, y, z)
• dense voxel arrays use (z, y, x)
• compatibility pickle files store num_voxels as (z, y, x)

Quick start

from voxelerate import build_voxel_octree, load_mesh, plot_central_slices, show, voxelize

mesh = load_mesh("path/to/your_mesh.stl")
voxel_grid = voxelize(
    mesh,
    voxel_size=0.25,
    mode="solid",
    pixel_size=0.015,
)

print(mesh.summary())
print(voxel_grid.summary())

show(mesh, voxel_grid=voxel_grid, title="Voxelerate - quick start")

voxel_octree = build_voxel_octree(voxel_grid, max_depth=8)
plot_central_slices(
    voxel_grid,
    octree=voxel_octree,
    max_depth=5,
    title="Mesh - central slices",
)

voxel_grid.save_pickle("mesh_solid.pkl", format="hybrid")

Interactive viewer

The viewer is meant for inspection and presentation. The control summary is shown directly in the window title, and the same reference is also available from Python:

from voxelerate import viewer_controls_help

print(viewer_controls_help())

Current viewer controls:

• Left drag: orbit camera
• Right drag: pan camera
• Mouse wheel: zoom camera
• Arrow keys: rotate the displayed preview
• Plus / minus: scale the displayed preview while held
• M: toggle mesh rendering
• B: toggle bounding box
• G: toggle ground grid
• O: toggle BVH / octree overlays
• V: toggle voxel rendering
• W: toggle wireframe
• X: toggle x-ray solid-voxel preview
• R: reset the camera
• T: reset the preview transform
• Esc: close the viewer

The ground grid starts off by default. Press G to enable it when needed.

Preview controls are visual only. They never change the voxelized result. To affect voxelization, pass an explicit transform matrix or translation / rotation / scale inputs into voxelize(...) or voxelize_on_grid(...).

Output formats

Voxel grids

Voxelerate can save voxel data in multiple formats.

• Hybrid pickle: rich metadata plus compatibility keys for older workflows
• Legacy pickle: compatibility-first output matching the previous key layout
• NPZ: compressed array-based storage

A typical hybrid pickle contains:

• voxel data as a NumPy array
• bounds_min_xyz
• bounds_max_xyz
• grid_size_xyz
• voxel_size
• pixel_size
• axis_order
• voxelization mode
• additional metadata

Spatial structures

Flattened BVH and octree archives are stored as compressed NPZ files so they can be loaded later without rebuilding. This is especially useful for large meshes where hierarchy construction can be expensive.

Slice visualization

Voxelerate includes central-slice inspection for dense voxel grids.

• central X / Y / Z slice plotting
• optional BVH or octree overlays
• light occupied voxels with red hierarchy overlays
• save-to-image support through matplotlib
• compatible with both surface and solid voxelization results

Example:

from voxelerate import build_voxel_octree, load_voxel_grid, plot_central_slices

grid = load_voxel_grid("mesh_solid.pkl")
octree = build_voxel_octree(grid, max_depth=8)

plot_central_slices(
    grid,
    octree=octree,
    max_depth=5,
    title="Central voxel slices with octree overlay",
)

Included models

The GitHub repository ships with a small curated set of demo assets under models/. These assets are intended for the repository examples and are not part of the runtime wheel installed from PyPI.

• David.stl
• Eiffel_Tower.stl
• C12.STL
• 2,5 mm cut.STL

Examples

The GitHub repository includes a small curated examples/ folder centered on the main visualization and voxelization workflows. If you install Voxelerate from PyPI, clone or download the repository to run these example scripts with the bundled demo assets.

• 01_single_mesh_pipeline.py — load models/Eiffel_Tower.stl, build a solid voxel grid, construct a BVH and mesh octree, visualize the mesh / grid / hierarchies, save the voxel grid, then inspect slices with a voxel-octree overlay.
• 02_shared_grid_two_meshes.py — voxelize two meshes on the same explicit grid defined by the larger outer mesh, visualize both results, and compare their slice plots.
• 03_spatial_reuse.py — save BVH and octree archives for later reuse, reload them, then visualize the reloaded structures and slice overlays.

See examples/README.md for the curated example workflows and run instructions.

Command-line interface

Open a mesh viewer:

voxelerate view path/to/mesh.stl

Voxelize a mesh using automatic bounds:

voxelerate voxelize path/to/mesh.stl   --voxel-size 0.25   --mode solid   --pixel-size 0.015   --output mesh_solid.pkl

Voxelize with explicit transform vectors:

voxelerate voxelize path/to/mesh.stl   --voxel-size 0.5   --translate 0.0 0.0 0.0   --rotate 0.0 25.0 0.0   --scale 1.0   --mode surface   --output mesh_surface_transformed.pkl

Voxelize on an explicit grid:

voxelerate voxelize path/to/mesh.stl   --grid-size 267 223 267   --bounds-min 0 0 0   --bounds-max 12 10 12   --mode solid   --output mesh_shared_grid.pkl

Inspect slices from a saved voxel grid:

voxelerate slices mesh_solid.pkl --show-octree

Build and save a BVH:

voxelerate bvh path/to/mesh.stl --strategy median --max-leaf-size 8 --save mesh.bvh.npz

Build and save a voxel octree:

voxelerate octree mesh_solid.pkl --max-depth 8 --save mesh_octree.npz

Notes for large meshes

For meshes with hundreds of thousands or millions of triangles:

• BVH construction can take noticeable time in pure Python and NumPy
• strategy="median" is usually faster than strategy="sah"
• saved flattened BVH or octree archives can avoid rebuilding every run
• viewer preview transforms remain lightweight because they are display-only

Repository layout

Voxelerate/
├── docs/
│   └── assets/
├── examples/
├── models/
├── src/voxelerate/
│   ├── shaders/
│   ├── viewer.py
│   ├── voxelizer.py
│   ├── voxel_grid.py
│   ├── bvh.py
│   ├── octree.py
│   └── ...
├── tests/
├── pyproject.toml
├── requirements.txt
├── LICENSE
└── README.md

Citation

If you use Voxelerate in academic work, cite the software repository and the specific release or commit you used.

@software{voxelerate,
  title   = {Voxelerate: GPU Mesh Visualization, Voxelization, and Spatial Hierarchies for 3D Geometry},
  author  = {hsafari68},
  year    = {2026},
  version = {0.5.7},
  url     = {https://github.com/hsafari68/Voxelerate},
  note    = {}
}

License

Voxelerate is distributed under a non-commercial license. Personal, academic, educational, and other non-commercial use is allowed, but commercial use is not permitted without prior written permission. See LICENSE for the full license text.