.. _api:

.. module:: varipeps

######################
variPEPS API reference
######################

This reference documents the public API of the :mod:`varipeps` module. The API
documentation is automatically generated from the source code of the
:obj:`varipeps` library and is therefore licensed under the
:ref:`license_gpl_3`.

.. toctree::
   :maxdepth: 2

   config
   contractions/index
   ctmrg/index
   expectation/index
   mapping/index
   optimization/index
   peps/index
   typing
   utils/index