You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gridlock/gridlock
Jan Petykiewicz 73d07bbfe0 disaambiguate some variables for typing purposes 2 years ago
..
examples typing and formatting updates 2 years ago
test typing and formatting updates 2 years ago
LICENSE.md move to hatch-based builds 2 years ago
README.md move to hatch-based builds 2 years ago
__init__.py bump version to v1.1 2 years ago
direction.py add all files 8 years ago
draw.py disaambiguate some variables for typing purposes 2 years ago
error.py simplify GridError definition 3 years ago
grid.py typing and formatting updates 2 years ago
position.py typing and formatting updates 2 years ago
py.typed add py.typed 3 years ago
read.py typing and formatting updates 2 years ago

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 (written and tested with 3.9)
  • 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