radtools.CUB#

radtools.CUB(a: float, return_cell=False)[source]#

Construct cubic primitive lattice.

See Cubic (CUB) for the definition of primitive and conventional cells.

Parameters:
afloat or int

Length of the all three lattice vectors of the conventional cell.

return_cellbool, default False

Whether to return the cell instead of the Lattice object.

Returns:
latticeLattice or (3, 3) numpy.ndarray

Cubic lattice or cell.