jan/gridlock
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
3D grid 'rasterizer', for generating discretized simulation grids.
91 Commits 2 Branches 9 Tags 429 KiB
Python 100%
a15e4bc05e
Go to file
Jan Petykiewicz a15e4bc05e repeat re-exported names
2024-07-29 00:44:26 -07:00
gridlock repeat re-exported names 2024-07-29 00:44:26 -07:00
.flake8 flake8 fixup 2024-07-18 00:17:45 -07:00
.gitignore gitignore mypy_cache 2021-07-11 17:22:46 -07:00
LICENSE.md add license 2016-04-13 03:52:08 -07:00
pyproject.toml bump min python version to 3.11 due to Self type 2024-07-18 00:20:18 -07:00
README.md bump min python version to 3.11 due to Self type 2024-07-18 00:20:18 -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