Skip to main content

hypertiling is a high-performance Python library for the generation and visualization of regular hyperbolic lattices

Project description

project icon

PyPI PyPI - Downloads DOI Website Discord

badge_coverage badge_maintainability badge_pipeline

hypertiling is a high-performance Python library for the generation and visualization of regular hyperbolic lattices embedded in the Poincare disk model. Using highly optimized, efficient algorithms, hyperbolic tilings with millions of vertices can be created in a matter of minutes on a single workstation computer. Facilities including computation of adjacent vertices, dynamic lattice manipulation, refinements, as well as powerful plotting and animation capabilities are provided to support advanced uses of hyperbolic graphs.

Installation

hypertiling is available in the PyPI package index and can be installed using

$ pip install hypertiling

For optimal performance, we highly recommand to use hypertiling together with python-numba, which, if not already present on your system can be installed automatically using the [numba]-suffix, i.e.

$ pip install hypertiling[numba]

The package can also be locally installed from our public git repository via

$ git clone https://git.physik.uni-wuerzburg.de/hypertiling/hypertiling
$ pip install .

Quick Start

In Python, import tiling object from the hypertiling library

from hypertiling import HyperbolicTiling

Set parameters, initialize and generate the tiling

p = 7
q = 3
nlayers = 5

T = HyperbolicTiling(p,q,nlayers) 

Documentation

Further usage examples and a full API reference are available in our documentation.

Authors

This project is developed at:
Institute for Theoretical Physics and Astrophysics
University of Wuerzburg

Citation

If you use hypertiling, we encourage you to cite or reference this work as you would any other scientific research. The package is a result of a huge amount of time and effort invested by the authors. Citing us allows us to measure the impact of the research and encourages others to use the library.

Cite us:

Manuel Schrauth, Yanick Thurn, Florian Goth, Jefferson S.E. Portela, Dietmar Herdt and Felix Dusel. (2023). The hypertiling project. Zenodo. https://doi.org/10.5281/zenodo.7559393

Examples

Tilings

The core functionality of the package is the generation of regular hyperbolic tilings projected onto the Poincare disk. Tilings in the upper row are centered about a cell, in the lower row about a vertex.

Refinements

The hypertiling package allows to perform triangle refinements, such as shown here

Applications

Hyperbolic Magnet

Simulation of a Ising-like Boltzmann spin model with anti-ferromagnetic interactions on a hyperbolic (7,3) tiling, quenched at low temperature. The hyperbolic antiferromagnet (left) exhibits geometrical frustration, whereas on a flat lattice (right) an ordered anti-parallel alignment can be observed.

Helmholtz Equation

Solution of an electrostatic Helmholtz problem on a refined (3,7) tiling, where boundary values have been fixed to either -1 (red) or +1 (blue). One readily recognizes a field value separation according to geodesic arcs in the Poincare disk representation of the hyperbolic plane.

Further information and examples can be found in our Jupyter notebooks in /examples subfolder.

License

Every part of hypertiling is available under the MIT license.

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

hypertiling-1.3.5.tar.gz (74.6 kB view details)

Uploaded Source

Built Distribution

hypertiling-1.3.5-py3-none-any.whl (88.8 kB view details)

Uploaded Python 3

File details

Details for the file hypertiling-1.3.5.tar.gz.

File metadata

  • Download URL: hypertiling-1.3.5.tar.gz
  • Upload date:
  • Size: 74.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.6

File hashes

Hashes for hypertiling-1.3.5.tar.gz
Algorithm Hash digest
SHA256 745cf03f797341a5056e09baf642c06d2a66afea3f542096fea5903545abfe80
MD5 c625b6defbed2160c87e7500f3daea35
BLAKE2b-256 c22fed3b489e7f452966940530e77cd8473bbaaaed4d6623e6a647bbda132e57

See more details on using hashes here.

File details

Details for the file hypertiling-1.3.5-py3-none-any.whl.

File metadata

  • Download URL: hypertiling-1.3.5-py3-none-any.whl
  • Upload date:
  • Size: 88.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.6

File hashes

Hashes for hypertiling-1.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 66c7d5f28bd203c907b2bef460addee2683dd0732fa6b90302ab4637e306d1c5
MD5 181b4ea712f09bc9528e797ae8469e86
BLAKE2b-256 13bc74dc86824d5361ca187c419717f21af068fad1fe1b0e52b0042f34a02837

See more details on using hashes here.

Supported by

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