History

Jan Petykiewicz e256f56f2b fix handling of 3d polys		2024-07-29 01:47:12 -07:00
..
examples	fix typos in arg names in example	2024-07-29 01:38:42 -07:00
test	comment unused import	2024-07-29 00:50:08 -07:00
__init__.py	repeat re-exported names	2024-07-29 00:44:26 -07:00
base.py	refactor to avoid class-scoped imports	2024-07-29 01:37:58 -07:00
direction.py	add all files	2016-03-15 20:07:07 -07:00
draw.py	fix handling of 3d polys	2024-07-29 01:47:12 -07:00
error.py	simplify GridError definition	2021-01-08 23:03:22 -08:00
grid.py	refactor to avoid class-scoped imports	2024-07-29 01:37:58 -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	refactor to avoid class-scoped imports	2024-07-29 01:37:58 -07:00
README.md	move to hatch-based builds	2022-08-29 13:07:46 -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