This repository includes Python 3 implementations of the Gilt-TNR algorithm for different lattices.
The Gilt-TNR algorithm is described in the arXiv e-print "Renormalization of tensor networks using graph independent local truncations" available at https://arxiv.org/abs/1709.07460.
The implementations in this repository may remain under development, and no permanence is guaranteed.
For code that is guaranteed to reproduce the results in the aforementioned paper, see the ancillary files of the arXiv submission (directory anc in the tarball https://arxiv.org/src/1709.07460).
The square lattice version of Gilt-TNR is implemented in GiltTNR2D.py. This implementation is fully functional and produces accurate physical observables for the models we have tested it on. Further development may or may not happen.
Work for a cubical lattice version is ongoing in GiltTNR3D.py The code is in a runnable state, and it tries to perform a Gilt-TNR step on a given model. However, bugs are still possible, even probable, performance needs significant improvement, and the design of the algorithm may still change.
All the source code is licensed under the MIT license, as described in the file LICENSE.
For any questions or comments, please email Markus Hauru at [email protected].
First of all, you need Python 3. If you don't yet have it installed, an easy way to get started is to use a scientific Python distribution like anaconda: https://www.anaconda.com/download/
After that, on Linux and Mac installation is as simple as
git clone https://github.com/Gilt-TNR/Gilt-TNR
cd Gilt-TNR
pip install --user -r requirements.txt
If you are using Windows, or something like anaconda, and don't have pip available, you just need to make sure that
a) You have the files from this repository. You can git clone to get them, or if you don't use git, just click the green "Clone or download" button.
b) You have installed the packages listed in requirements.txt. These are SciPy (the code has been tested with SciPy 0.18.1), tntools, ncon, and abeliantensors.
Once you have everything installed, you can check that things work by running for instance
python3 GiltTNR2D_test.py -c 'confs/GiltTNR2D_test_batch.yaml' -y 'gilt_eps: !!float 1e-7' 'beta: 0.4'
which should compute the free energy of the Ising model at beta = 0.4.
The main files that implement the square and cubical versions of the algorithm are GiltTNR2D.py and GiltTNR3D.py.
For documentation on how the code works, see the source code itself.
For each of the algorithms the following also exist.
A _envspec.py file
A script that runs the Gilt-TNR algorithm to produce coarse-grained tensors, and then gets the environment spectrum for a given environment, and prints it out.
A _test.py file
A script that runs the Gilt-TNR algorithm on a given lattice model, producing coarse-grained tensors, and evaluating and printing out various things, such as free energies and spectra of the coarse-grained tensors.
A _setup.py file
A module for interfacing for with tntools.datadispenser module.
This is usually of no concern to the user.
See the source code for tntools.datadispenser for more details.
There's also the file GiltTNR3D_impurity.py which applies the GiltTNR3D algorithm to an impurity.
This remains unfinished at the moment.
To run the scripts, commands of the following form can be used:
python3 GiltTNR2D_test.py -c 'confs/GiltTNR2D_test_batch.yaml' -y 'gilt_eps: !!float 1e-7' 'beta: 0.4'
The command line argument -c specifies a configuration file, that lists values for the various parameters that the _test.py script and the algorithm itself take.
These files use the YAML format.
Parameters in a configuration file can be appended or overriden by providing more command line arguments after the -y flag.
Each argument should be a string, that could be added as a line to the YAML file.
The various parameters that can be used are defined in the beginning of the scripts and in the docstrings in the main algorithm files.
The code makes significant use of lower level tools from the three packages abeliantensors, ncon, and tntools. abeliantensors is a library for implementing basic tensor operations, such as decompositions and contractions. The key benefit over numpy's ndarrays (which it uses under the hood) is that abeliantensors supports tensors with internal Abelian symmetries (see https://arxiv.org/abs/1008.4774). ncon is a Python implementation of the NCon function, as described here: https://arxiv.org/abs/1402.0939. tntools is a collection of miscellaneous tools useful when working with tensor network algorithms. See the repositories themselves for more documentation.
Note that all the actual running of the coarse-graining algorithms, and generating coarse-grained tensors, happens using a module called tntools.datadispenser. The user interface is mainly through the function datadispenser.get_data, for which usage examples can be seen in the _test.py and _envspec.py scripts. The idea is that the user specifies the type of data (typically just A, which is used as the name for coarse-grained tensors as in the paper, or As for the algorithms were several A tensors are needed, such as GiltTNR3D) and the parameters for creating this data (in a dictionary). datadispenser then generates this data, and stores it on disk, so that the next time the same data is requested, datadispenser just finds it on the disk and returns it from there. Note that if one edits the code, either the old data should be purged, or the version number of the algorithm should be changed, so that datadispenser knows the regenerate all data that is requested. See the docstring for datadispenser and its functions for more details.