3.1. kwant – Top level package

For convenience, short names are provided for a few widely used objects from the sub-packages. Otherwise, this package has only very limited functionality of its own.

Generic functionality

kwant.__version__ = '1.5.1.dev62+g887522e02'

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to ‘utf-8’. errors defaults to ‘strict’.

KwantDeprecationWarning	Class of warnings about a deprecated feature of Kwant.
UserCodeError	Class for errors that occur in user-provided code.

From kwant.builder

Builder([symmetry, conservation_law, ...])	A tight binding system defined on a graph.
HoppingKind(delta, family_a[, family_b])	A pattern for matching hoppings.

From kwant.lattice

TranslationalSymmetry(*periods)

A translational symmetry defined in real space.

From kwant.plotter

plot(sys[, num_lead_cells, unit, ...])

Plot a system in 2 or 3 dimensions.

From kwant.solvers.default

greens_function(sys[, energy, args, ...])	Compute the retarded Green's function of the system between its leads.
ldos(sys[, energy, args, check_hermiticity, ...])	Calculate the local density of states of a system at a given energy.
smatrix(sys[, energy, args, out_leads, ...])	Compute the scattering matrix of a system.
wave_function(sys[, energy, args, ...])	Return a callable object for the computation of the wave function inside the scattering region.