wulfric.lattice_example

wulfric.lattice_example(lattice_name: str = None, convention: 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.

conventionstr, optional

Name of the convention that is used for cell standardization. Supported conventions are: * "sc" - for Setyawan and Curtarolo standardization.

By default the lattice is not standardized.

Added in version 0.3.1.

Returns:

latticeLattice or list

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