3.2. kwant.builder – High-level construction of systems

Types

Builder([symmetry, conservation_law, ...]) A tight binding system defined on a graph.
Site A site, member of a SiteFamily.
HoppingKind A pattern for matching hoppings.
SimpleSiteFamily([name, norbs]) A site family used as an example and for testing.
BuilderLead(builder, interface) A lead made from a Builder with a spatial symmetry.
SelfEnergyLead(selfenergy_func, interface) A general lead defined by its self energy.
ModesLead(modes_func, interface) A general lead defined by its modes wave functions.
FiniteSystem Finalized Builder with leads.
InfiniteSystem Finalized infinite system, extracted from a Builder.

Abstract base classes

SiteFamily(canonical_repr, name, norbs) Abstract base class for site families.
Symmetry Abstract base class for spatial symmetries.
Lead Abstract base class for leads that can be attached to a Builder.