Skip to main content

Compute and plot hexagonal grids

Project description

hexalattice

Generate and plot hexagonal lattices in 2D, with fine control over spacing between hexagons, arbitrary rotation of the grid around central tile, etc. The module computes and returns the center point for each of the tiles in the lattice.

Installation

PyPI version conda python version downloads_anaconda license last updated

# Using pip
pip install hexalattice
# Using conda
conda install -c conda-forge hexalattice

Usage example

Create and plot 5x5 lattice of hexagons (as in first image):

from hexalattice.hexalattice import *
hex_centers, _ = create_hex_grid(nx=5,
                                 ny=5,
                                 do_plot=True)
                                 
plt.show()    # import matplotlib.pyplot as plt

Get central points of the hexagons:

tile_centers_x = hex_centers[:, 0]
tile_centers_y = hex_centers[:, 1]

Plot one grid over the other, second with spacing around the hexagons:

_, h_ax = create_hex_grid(nx=5, 
                          ny=7,
                          do_plot=True,
                          edge_color=(0.85, 0.85, 0.85))
                                    
create_hex_grid(nx=5,
                ny=7,
                do_plot=True,
                edge_color=(0.25,0.25, 0.25),
                h_ax=h_ax,
                plotting_gap=0.3)
plt.show()

Create Moirֳ© pattern from two circularly cropped hexagrids:

hex_grid1, h_ax = create_hex_grid(nx=50,
                                  ny=50,
                                  rotate_deg=0,
                                  min_diam=1,
                                  crop_circ=20,
                                  do_plot=True)
    create_hex_grid(nx=50,
                    ny=50,
                    min_diam=1,
                    rotate_deg=5,
                    crop_circ=20,
                    do_plot=True,
                    h_ax=h_ax)

For API and additional examples see the wiki hexalattice API and assigning individual colors to hexagons.

Release History

  • v1.0.0 - First version
  • v1.1.0 - Added the option to assign different colors to hexagons
  • v1.2.0 - Added control over the outer line width of the hexagons
  • v1.2.2 - Added control over the axis background color
  • v1.3.0 - Reduced runtime by 50%

About & License

Alex Kazakov ג€“ @bio_vs_silico ג€“ alex.kazakov@mail.huji.ac.il

Distributed under the MIT license. See LICENSE for more information.

https://github.com/alexkaz2/hexalattice

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hexalattice-1.3.0.tar.gz (8.3 kB view details)

Uploaded Source

File details

Details for the file hexalattice-1.3.0.tar.gz.

File metadata

  • Download URL: hexalattice-1.3.0.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for hexalattice-1.3.0.tar.gz
Algorithm Hash digest
SHA256 58acdc6da8aa13553d7155ca36b54f7572aba0f6e63436ed0391e5a9e5f28ce4
MD5 4b18a6f660229f76449306b56b5117f7
BLAKE2b-256 b01aea7c7a8067cb01cda84a78a6cbfd83f972b1c7d050ce050bce38d2a9efc0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page