Commit 320fa809 authored by Manuel Schrauth's avatar Manuel Schrauth
Browse files

Update README.md

parent 886063b8
# Hypertiling
This is a Python 3 libary for the fast generation of regular hyperbolic tilings, embedded in the Poincare disk model.
......@@ -11,7 +10,7 @@ Using efficient algorithms and the power of numpy, hyperbolic graphs with millio
# Installation
Hypertiling is not yet available for `pip`, but can be locally built using
Hypertiling is not yet available for `pip`, but can be locally built on Linux systems using
```
$ python setup.py install
```
......@@ -20,3 +19,35 @@ For developer mode use
```
$ python setup.py develop
```
## Usage
Import tiling object from *hypertiling* library
```python
from hypertiling import HyperbolicTiling
```
Set parameters, initialize and generate the tiling
```python
p = 7
q = 3
nlayers = 5
T = HyperbolicTiling(p,q,nlayers)
T.generate()
```
Further information can be found in our Jupyter notebooks in /examples subfolder.
## Authors
* Manuel Schrauth (mschrauth@physik.uni-wuerzburg.de)
* Felix Dusel
This project is developed at the Institute for Theoretical Physics and Astrophysics, University of Wuerzburg
## License
Every part of hypertiling is available under the MIT license.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment