History

Jan Petykiewicz 22cb410d84 [GridData / save / load] Add GridData and update save format		2026-04-21 20:00:52 -07:00
..
examples	Major rework of arguments using Extent/Slab/Plane	2025-01-28 19:36:59 -08:00
test	[GridData / save / load] Add GridData and update save format	2026-04-21 20:00:52 -07:00
__init__.py	[GridData / save / load] Add GridData and update save format	2026-04-21 20:00:52 -07:00
base.py	[Grid] enable negative shifts	2026-04-21 20:00:00 -07:00
data.py	[GridData / save / load] Add GridData and update save format	2026-04-21 20:00:52 -07:00
draw.py	[draw] fix extrude without out-of-bounds slice	2026-04-20 10:52:45 -07:00
grid.py	[GridData / save / load] Add GridData and update save format	2026-04-21 20:00:52 -07:00
LICENSE.md	move to hatch-based builds	2022-08-29 13:07:46 -07:00
position.py	[ind2pos] fix rounding and bounds	2026-04-20 10:25:13 -07:00
py.typed	add py.typed	2021-01-09 00:58:17 -08:00
read.py	[Grid] enable negative shifts	2026-04-21 20:00:00 -07:00
README.md	move to hatch-based builds	2022-08-29 13:07:46 -07:00
utils.py	improve arg checking	2026-04-20 10:47:35 -07:00

README.md

Gridlock README

Gridlock is a Python module for drawing on coupled grids.

Gridlock is used primarily for 'painting' shapes in 3D on multiple grids which represent the same spatial region, but are offset from each other. It does straightforward natural <-> grid unit conversion and can handle non-uniform rectangular grids (the entire grid is generated based on the coordinates of the boundary points along each axis).

Installation

Requirements:

python >3.11 (written and tested with 3.12)
numpy
float_raster
matplotlib (optional, used for visualization functions)
mpl_toolkits.mplot3d (optional, used for isosurface visualization)
skimage (optional, used for isosurface visualization)

Install with pip:

pip3 install gridlock

Alternatively, install via git

pip3 install git+https://mpxd.net/code/jan/float_raster.git@release
pip3 install git+https://mpxd.net/code/jan/gridlock.git@release