Typing (sisl.typing)

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

The typing types are shown below:

AxisIntLiteral
CellAxisStrLiteral
CellAxisLiteral	Represent a union type
CartesianAxisStrLiteral
CartesianAxisLiteral	Represent a union type
CellAxis	Represent a union type
CellAxes	Represent a union type
CartesianAxis	Represent a union type
CartesianAxes	Represent a union type
AnyAxis	Represent a union type
AnyAxes	Represent a union type

SimpleIndex	Represent a union type
AtomsIndex	Represent a union type
OrbitalsIndex	Represent a union type

AtomLike	Represent a union type
AtomsLike	Represent a union type
CellLike	Represent a union type
Coord	All the operations on a read-only sequence.
CoordOrScalar	Represent a union type
FuncType
GaugeType
GeometryLike	Represent a union type
GridLike	Represent a union type
KPoint	All the operations on a read-only sequence.
LatticeLike	Represent a union type
LatticeOrGeometry	Represent a union type
LatticeOrGeometryLike	Represent a union type
ProjectionTypeMatrix
ProjectionTypeTrace
ProjectionTypeDiag
ProjectionTypeHadamard
ProjectionTypeHadamardAtoms
ProjectionType	Represent a union type
DistributionStr
DistributionFunc
DistributionType	Represent a union type
RotationType	Represent a union type
SileLike	Represent a union type
SparseMatrix	Represent a union type
SparseMatrixExt	Represent a union type
SparseMatrixGeometry	Represent a union type
SparseMatrixPhysical	Represent a union type
SpinType	Represent a union type
UnitsVar	Represent a union type

SeqBool	All the operations on a read-only sequence.
SeqOrScalarBool	Represent a union type
SeqInt	All the operations on a read-only sequence.
SeqOrScalarInt	Represent a union type
SeqFloat	All the operations on a read-only sequence.
SeqOrScalarFloat	Represent a union type