Welcome to spinWannier’s documentation!#

The spinWannier project on GitHub is a Python package for handling Wannier models with a spin operator, calculating the Wannier model quality and spin-texture plotting, as illustrated below.

_images/spinWannier_example_figure.jpg


If you find this package useful, please cite L. Vojáček*, J. M. Dueñas* et al., Nano Letters (2024).

Quickstart#

pip install spinWannier

then

git clone https://github.com/liborsold/spinWannier.git

and execute the ./examples/spinWannier_use_example.ipynb Jupyter notebook to see an example of calculating the Wannier (spin) interpolation, 1D and 2D spin-texture plotting and Wannier model quality calculation.

Indices and tables#