kwant.lattice.general

kwant.lattice.general(prim_vecs, basis=None, name='')

Create a Bravais lattice of any dimensionality, with any number of sites.

Parameters:

prim_vecs : sequence of sequences of floats

The primitive vectors of the Bravais lattice.

basis : sequence of floats

The coordinates of the basis sites inside the unit cell.

name : string or sequence of strings

Name of the lattice, or the list of names of all of the sublattices. If the name of the lattice is given, the names of sublattices (if any) are obtained by appending their number to the name of the lattice.

Returns:

lattice : either Monatomic or Polyatomic

Resulting lattice.

Notes

This function is largely an alias to the constructors of corresponding lattices.