pymf.md

Package reference

Interactive problem definition

To define the interactive problem, we use the following class:

.. autoclass:: pymf.model.Model
   :members: mfield

Mean-field and density matrix

.. automodule:: pymf.mf
   :members: meanfield, construct_density_matrix, construct_density_matrix_kgrid, fermi_on_kgrid
   :show-inheritance:

Observables

.. automodule:: pymf.observables
   :members: expectation_value
   :show-inheritance:

Solvers

.. automodule:: pymf.solvers
   :members: solver, cost
   :show-inheritance:

Tight-binding dictionary

Manipulation

.. automodule:: pymf.tb.tb
   :members: add_tb, scale_tb
   :show-inheritance:

Brillouin zone transformations

.. automodule:: pymf.tb.transforms
   :members:
   :show-inheritance:

Parametrisation

.. automodule:: pymf.params.rparams
   :members:
   :show-inheritance:

Utility functions

.. automodule:: pymf.tb.utils
   :members:
   :show-inheritance:

kwant interface

.. automodule:: pymf.kwant_helper.utils
   :members:
   :show-inheritance: