tepkit.core.symmetry.LayerGroup

tepkit.core.symmetry.LayerGroup#

class tepkit.core.symmetry.LayerGroup#

The class for layer group analysis.

Attributes#

Attribute

Default Value

Description

data

None

Properties#

number

Methods#

from_file(path, fmt[, aperiodic_axis, sym_prec])

from_poscar(poscar[, aperiodic_axis, sym_prec])

get_data_from_spglib(cell[, aperiodic_axis, sym_prec])

add_additional_data(→ None)

All Members#

data = None
classmethod from_file(path, fmt, aperiodic_axis: Axis | Type[Axis] = Axis.a3, sym_prec: float = 1e-05)
>>> layer_group = LayerGroup.from_file("Bi2Te3.poscar", fmt="vasp")
>>> layer_group.number
72
>>> layer_group.data.international
'p-3m1'
classmethod from_poscar(poscar: tepkit.io.vasp.Poscar, aperiodic_axis: Axis = Axis.a3, sym_prec: float = 1e-05)
get_data_from_spglib(cell, aperiodic_axis: Axis = Axis.a3, sym_prec: float = 1e-05)
property number: int
add_additional_data() None