History

jan d3f76fa475 bump version to v2.1		2025-12-10 20:31:31 -08:00
..
examples	Major rework of arguments using Extent/Slab/Plane	2025-01-28 19:36:59 -08:00
test	Major rework of arguments using Extent/Slab/Plane	2025-01-28 19:36:59 -08:00
__init__.py	bump version to v2.1	2025-12-10 20:31:31 -08:00
base.py	type annotation improvements	2024-07-29 01:57:39 -07:00
draw.py	update docs to reflect new args	2025-04-16 21:25:43 -07:00
grid.py	Copy pixel edge coordinates	2024-07-31 22:51:07 -07:00
LICENSE.md	move to hatch-based builds	2022-08-29 13:07:46 -07:00
position.py	refactor to avoid class-scoped imports	2024-07-29 01:37:58 -07:00
py.typed	add py.typed	2021-01-09 00:58:17 -08:00
read.py	[read] more fixup for visualize_edges	2025-09-22 22:24:15 -07:00
README.md	move to hatch-based builds	2022-08-29 13:07:46 -07:00
utils.py	update docs to reflect new args	2025-04-16 21:25:43 -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