TeNPy (short for TEnsor Networks Python) is a Python library for the simulation of strongly correlated quantum systems with tensor networks.
The philosophy of this library is to get a new balance of a good readability and usability for new-comers, and at the same time powerful algorithms and fast development of new algorithms for experts. For good readability, next to the code we include an extensive documentation, both in Python doc strings and separately as user guides, as well as simple example codes and even toy codes, which just demonstrate various algorithms (like TEBD and DMRG) in ~100 Lines per file.
Follow the instructions in :doc:`doc/INSTALL.rst <INSTALL>`.
The documentation is available online at https://tenpy.github.io.
The documentation is based on Python's docstrings, and some additional *.rst files located in the folder doc/ of
the repository.
All documentation should be formated as reStructuredText,
whis means it is readable in the source plain text, but can also be converted to other formats.
If you like it simple, you can just use intective python help(), Python IDEs of your choice (or jupyter notebooks), or just read the source.
The documentation is nightly converted into HTML using Sphinx, as mentioned above available online at https://tenpy.github.io/. You can also build the documentation yourself, as described in :doc:`doc/contributing.rst <contributing>`. Sphinx can generate the documentation in various output formats, including HTML and LATEX/PDF.
The documentation is roughly split in two parts: the full reference containing the documentation of all functions, classes, methods, etc, and the userguide containing some introductions and additional explanations.
You might want to check the github issues, if someone else already reported the same problem. To report a new bug, just open a new issue on github. If you already know how to fix it, you can just create a pull request :)
The code is licensed under GPL-v3.0 given in the file LICENSE of the repository,
in the online documentation readable at https://tenpy.github.io/license.html.