Typing

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

The typing types are shown below:

AxisIntLiteral

alias of Literal[0, 1, 2]

CellAxisStrLiteral

alias of Literal['a', 'b', 'c']

CellAxisLiteral

alias of Literal[0, 1, 2] | Literal['a', 'b', 'c']

CartesianAxisStrLiteral

alias of Literal['x', 'y', 'z']

CartesianAxisLiteral

alias of Literal[0, 1, 2] | Literal['x', 'y', 'z']

CellAxis

alias of Literal[0, 1, 2] | Literal['a', 'b', 'c']

CellAxes

alias of Literal[0, 1, 2] | Literal['a', 'b', 'c'] | Sequence[Literal[0, 1, 2] | Literal['a', 'b', 'c']]

CartesianAxis

alias of Literal[0, 1, 2] | Literal['x', 'y', 'z']

CartesianAxes

alias of Literal[0, 1, 2] | Literal['x', 'y', 'z'] | Sequence[Literal[0, 1, 2] | Literal['x', 'y', 'z']]

AnyAxis

alias of Literal[0, 1, 2] | Literal['a', 'b', 'c'] | Literal['x', 'y', 'z']

AnyAxes

alias of Literal[0, 1, 2] | Literal['a', 'b', 'c'] | Sequence[Literal[0, 1, 2] | Literal['a', 'b', 'c']] | Literal['x', 'y', 'z'] | Sequence[Literal[0, 1, 2] | Literal['x', 'y', 'z']]

SimpleIndex

alias of int | Sequence[int] | Sequence[bool]

AtomsIndex

alias of int | Sequence[int] | Sequence[bool] | str | dict | Atom | AtomCategory | GenericCategory | Shape | bool | None

OrbitalsIndex

alias of int | Sequence[int] | Sequence[bool] | str | dict | Atom | AtomCategory | Shape | bool | None

AtomLike

alias of int | str | Atom

AtomsLike

alias of int | str | Atom | Sequence[int | str | Atom] | Atoms

CellLike

alias of ndarray[Any, dtype[_ScalarType_co]] | list | tuple

Coord

All the operations on a read-only sequence.

CoordOrScalar

alias of float | Sequence[float]

FuncType

alias of Callable[[...], Any]

GaugeType

alias of Literal['cell', 'atom']

GeometryLike

alias of str | BaseSile | Path | Geometry

GridLike

alias of str | BaseSile | Path | Grid

KPoint

All the operations on a read-only sequence.

LatticeLike

alias of str | BaseSile | Path | Lattice | LatticeChild | ndarray[Any, dtype[_ScalarType_co]] | list | tuple

LatticeOrGeometry

alias of Lattice | Geometry

LatticeOrGeometryLike

alias of str | BaseSile | Path | Lattice | LatticeChild | ndarray[Any, dtype[_ScalarType_co]] | list | tuple | Geometry

SileLike

alias of str | BaseSile | Path

SparseMatrix

alias of spmatrix | sparray | SparseCSR

SparseMatrixExt

alias of spmatrix | sparray

UnitsVar

alias of str | Mapping[str, str] | Sequence[str]