Typing

sisl will use typing to enable static analyzers and to aid users when reading documentation.

The typing types is shown below:

AtomsArgument

alias of Union[ndarray[Any, dtype[Union[int64, bool_]]], str, int, dict, Atom, AtomCategory, GenericCategory, Shape]

OrbitalsArgument

alias of Union[ndarray[Any, dtype[Union[int64, bool_]]], str, int, dict, AtomCategory, Shape]

SileLike

alias of Union[BaseSile, str, Path]

AtomsLike

alias of Union[Atom, Atoms]

LatticeLike

alias of Union[BaseSile, str, Path, Lattice]

GeometryLike

alias of Union[BaseSile, str, Path, Geometry]

LatticeOrGeometry

alias of Union[Lattice, Geometry]

LatticeOrGeometryLike

alias of Union[BaseSile, str, Path, Lattice, Geometry]