kwant.builder.SimpleSiteFamily

class kwant.builder.SimpleSiteFamily(name=None, norbs=None)[source]

Bases: kwant.builder.SiteFamily

A site family used as an example and for testing.

A family of sites tagged by any python objects where object satisfied condition object == eval(repr(object)).

It exists to provide a basic site family that can be used for testing the builder module without other dependencies. It can be also used to tag sites with non-numeric objects like strings should this every be useful.

Due to its low storage efficiency for numbers it is not recommended to use SimpleSiteFamily when kwant.lattice.Monatomic would also work.

Methods

normalize_tag(tag)[source]

Return a normalized version of the tag.

Raises TypeError or ValueError if the tag is not acceptable.

Previous topic

kwant.builder.HoppingKind

Next topic

kwant.builder.BuilderLead

This Page