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.

3.1.1. Generic functionality

The version of Kwant is available under the name __version__.

KwantDeprecationWarning

Class of warnings about a deprecated feature of Kwant.

3.1.2. From kwant.builder

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

3.1.3. From kwant.lattice

TranslationalSymmetry(*periods)

A translational symmetry defined in real space.

3.1.4. From kwant.plotter

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

Plot a system in 2 or 3 dimensions.

3.1.5. 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.