asr.structureinfo

Summary

This is the documentation for asr.structureinfo-recipe. This recipe is comprised of a single instruction, namely:

Run this recipe through the CLI interface

$ asr run asr.structureinfo

or as a python module

$ python -m asr.structureinfo

Detailed description

Structural information.

Steps

asr.structureinfo

asr.structureinfo.main(atoms)[source]

Get structural information of atomic structure.

This recipe produces information such as the space group and magnetic state properties that requires only an atomic structure. This recipes read the atomic structure in structure.json.

Parameters

atoms (ase.atoms.Atoms) –

Return type

asr.structureinfo.Result

class asr.structureinfo.Result(pointgroup, cell_area, formula, stoichiometry, spglib_dataset, spgnum, crystal_type, spacegroup, has_inversion_symmetry)[source]
Parameters
  • pointgroup (str) –

  • cell_area (float) –

  • formula (str) –

  • stoichiometry (str) –

  • spglib_dataset (dict) –

  • spgnum (int) –

  • crystal_type (str) –

  • spacegroup (str) –

  • has_inversion_symmetry (bool) –

property cell_area: float

Area of unit-cell [Ang^2]

Return type

float

property crystal_type: str

Crystal type

Return type

str

property formula: str

Chemical formula.

Return type

str

property has_inversion_symmetry: bool

Material has inversion symmetry

Return type

bool

property pointgroup: str

Point group

Return type

str

property spacegroup: str

Space group

Return type

str

property spglib_dataset: dict

SPGLib symmetry dataset.

Return type

dict

property spgnum: int

Space group number

Return type

int

property stoichiometry: str

Stoichiometry

Return type

str