jan/gridlock
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
3D grid 'rasterizer', for generating discretized simulation grids.
82 Commits 2 Branches 9 Tags 429 KiB
Python 100%
9276f8f86b
Go to file
Jan Petykiewicz 9276f8f86b bump version to 1.0 
Breaking changes:
-`eps` argument renamed to `foreground`
- `Grid` no longer contains actual data (iem the data modified by draw_*
functions), only the metadata (edge positions, periodicity, etc.). Data
is now a user-managed ndarray.
2021-10-31 19:21:24 -07:00
gridlock bump version to 1.0 2021-10-31 19:21:24 -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
MANIFEST.in remove old VERSION file 2021-01-09 00:58:27 -08:00
README.md doc updates 2021-10-24 19:53:06 -07:00
setup.py update email 2021-07-11 17:22:58 -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 (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