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 .

Usage

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) 

Further examples are available in our documentation and Jupyter demo notebooks.

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.4.tar.gz (68.9 kB view details)

Uploaded Source

Built Distribution

hypertiling-1.3.4-py3-none-any.whl (84.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hypertiling-1.3.4.tar.gz
  • Upload date:
  • Size: 68.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for hypertiling-1.3.4.tar.gz
Algorithm Hash digest
SHA256 737c9b5672c5542378b256e495e0a169d50611645328627f8d6b715b22c64734
MD5 d8a0155805d3fde94acd7aeccfd8b1b6
BLAKE2b-256 8a37d3dea0b3a1ec58eadf2794b96f009e67ab8b2798cb810b6c474bcce1d18f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hypertiling-1.3.4-py3-none-any.whl
  • Upload date:
  • Size: 84.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for hypertiling-1.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 39b6f51541898b63d6f4a623acd6fcbe5dfdb65d3f2e6e71525fd628e644a8a2
MD5 11e0144965962dc3e28fb2566ff9c1d0
BLAKE2b-256 16a5d71754c5c32df54e3f7315b0d5231559398523f126b6067100d69ada7ce9

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