SpacegroupInfo

class ase2sprkkr.sprkkr.spacegroup_info.SpacegroupInfo(atoms, symmetry=True, dataset=None)[source]

Class, that carry information about spacegroup and symmetry of a structure

Class hierarchy

Inheritance diagram of ase2sprkkr.sprkkr.spacegroup_info.SpacegroupInfo

Constructor

Parameters:
__init__(atoms, symmetry=True, dataset=None)[source]
Parameters:
  • atoms (SPRKKRAtoms) – ASE atoms object desribed by the SpacegroupInfo

  • symmetry – Whether the by-symmetry-equivalent sites will share properties

  • dataset (Dict | None) – SPGLib dataset - a dictionary, containing many informations about the symmetry and spacegroup of the structure. If it is not provided, and spacegroup is not None the spacegroup is recomputed to obtain the dataset, if the dataset is requested.

to_dict()[source]
todict()
copy_for(atoms)[source]

Return copy of the object for the given atoms

check_spacegroup_kinds()[source]

Returns True, if the spacegroup_kinds array match the sites info.

update_spacegroup_kinds(if_required=False)[source]

Update the occupancy info and spagroup_kinds array

spacegroup_number()[source]
Returns:

Spacegroup number or None, if there is no spacegroup.

Return type:

spacegroup

property dataset: Dict | None

Return SpgLib dataset containing informations about symmetry, spacegroup, equivalence of sites etc…

property equivalent_sites: ndarray

Return numpy array, that tags the sites by its equivalence classes

recompute(symmetry=None, consider_old=True, precision=1e-05, angular_precision=1e-05, *, atomic_kinds=None, copy=False, init=False, update_info=True)[source]

Init the sites array: the array of Sites objects, that holds additional SPRKKR properties and informations about site-equivalence

block_updating(always_recompute=False, **kwargs)[source]