quimb.operator.pepobuilder
==========================

.. py:module:: quimb.operator.pepobuilder

.. autoapi-nested-parse::

   Tools for building projected entangled pair operators (PEPOs) from arbitrary
   local terms.



Functions
---------

.. autoapisummary::

   quimb.operator.pepobuilder.make_w_array
   quimb.operator.pepobuilder.PEPO_nearest_neighbor


Module Contents
---------------

.. py:function:: make_w_array(Lx, Ly, i, j, A, B, C, cyclic=False, dtype=None)

.. py:function:: PEPO_nearest_neighbor(A, B, C, Lx, Ly, cyclic=False, dtype=None, **pepo_opts)

   Create a PEPO for a sum of nearest neighbor interactions:

   .. math::

       H = \sum_{\{i,j\}} A_{i} \otimes B_{j} + \sum_i C_{i}

   where A and B define the left and right hand side of an interaction, and C
   is an on-site term. For example, the transverse field ising model can be
   written with `A = -j * Z`, `B = Z`, and `C = -h * X`.

   :param A: The left hand side interaction matrix.
   :type A: array_like
   :param B: The right hand side interaction matrix.
   :type B: array_like
   :param C: The on-site interaction matrix.
   :type C: array_like
   :param Lx: The number of sites in the x-direction.
   :type Lx: int
   :param Ly: The number of sites in the y-direction.
   :type Ly: int
   :param dtype: The data type of the PEPO tensors. If not provided, it will be inferred
                 from A, B, and C.
   :type dtype: str or dtype, optional
   :param pepo_opts: Additional options to pass to the `qtn.PEPO` constructor.
   :type pepo_opts: dict, optional

   :rtype: PEPO