Welcome to VoxelMap’s Documentation!

Make 3D models with NumPy + Python 🚀

View VoxelMap on GitHub

—

What is VoxelMap?

VoxelMap is a lightweight Python library for turning NumPy arrays into:

• Voxel models → colored cubes for quick prototyping.

• Meshes → low-poly .obj files with ImageMesh & MarchingMesh.

• Interactive 3D → zoom, pan, and rotate with PyVista.

It’s designed for simplicity first, with optional extras when you need more.

—

Quickstart

A red cube in 3 lines:

import numpy as np
from voxelmap import Model

arr = np.ones((3, 3, 3))
model = Model(arr)
model.set_color(1, "red")
model.draw_mpl("custom")

➡ Produces a solid red cube.

For more, see Core Usage.

—

Contents

• Installation
  • Supported Python
  • Quick install (core only)
  • Optional extras
  • Virtual environment (recommended)
  • Developer install (editable)
  • Upgrading / Uninstalling
  • Verify your install
  • Notes for interactive 3D (PyVista)
  • Building the documentation (optional)
  • Troubleshooting
• Core Usage
  • Voxel Arrays
  • Drawing Voxels
  • Custom Palettes
  • Colormap Gradients
  • Interactive 3D (Optional)
  • Saving and Loading
  • Summary
• API Reference
  • Global Functions
  • Model Class
  • Autosummary Index
• I/O Helpers
  • Saving and Loading JSON
  • Saving and Loading TXT
  • OBJ Export (with Meshing)
  • When to use what?
• Mesh Functions
  • ImageMesh
  • MarchingMesh
  • MeshView
  • When to use which?

Examples

• Voxel Model → 3D Mesh
• 3D Reconstruction from Images

Advanced

• ImageMesh: Low-Poly 3D Reconstruction

—

Notes

• VoxelMap v5.0.0 introduces a simplified API: use palette and set_color instead of hashblocks.

• Interactive features require optional installs (see Installation).

• This project is under active development. Contributions welcome!