radtools.lattice_example

radtools.lattice_example(lattice_name: str = None)

Return an example of the lattice.

Parameters:

lattice_namestr, optional

Name of the lattice to be returned. For available names see documentation of each Bravais lattice class. Lowercased before usage.

Returns:

latticeLattice or list

Lattice class is returned. If no math found a list with available examples is returned.