History

Jan Petykiewicz d44e02e2f7 return figure and axes after plotting		2024-07-18 00:17:58 -07:00
..
examples	typing and formatting updates	2022-10-18 19:44:30 -07:00
test	typing and formatting updates	2022-10-18 19:44:30 -07:00
__init__.py	bump version to v1.1	2022-08-29 13:11:12 -07:00
direction.py	add all files	2016-03-15 20:07:07 -07:00
draw.py	flake8 fixup	2024-07-18 00:17:45 -07:00
error.py	simplify GridError definition	2021-01-08 23:03:22 -08:00
grid.py	flake8 fixup	2024-07-18 00:17:45 -07:00
LICENSE.md	move to hatch-based builds	2022-08-29 13:07:46 -07:00
position.py	flake8 fixup	2024-07-18 00:17:45 -07:00
py.typed	add py.typed	2021-01-09 00:58:17 -08:00
read.py	return figure and axes after plotting	2024-07-18 00:17: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