SpinToolkit

SpinToolkit is a high-performance toolkit for simulating spin systems, including the following key functionalities:

• Linear spin wave (LSW) calculations based on Holstein-Primakoff bosons
• Generalized linear spin wave (GLSW) calculations based on SU(N) coherent state and Schwinger bosons
• Monte-Carlo sampling of spin dipoles or SU(N) coherent states
• Landau-Lifshitz dynamics
• Linear spin wave (LSW) based on Monte-Carlo sampling + Equation of motion approach
• ...

Documentation

• 🚀 Getting Started
• 🐳 Container Reference
• 📖 API Docs

Quick example — launch a Jupyter Notebook session:

docker run --rm -it \
       -p 8880:8880 \
       -v ${PWD}/tutorials:/home/ubuntu/tutorials:z \
       -w /home/ubuntu/tutorials \
       spintoolkit:1.6.0 \
       jupyter-notebook --no-browser --ip=0.0.0.0 --port=8880 --allow-root

Copy the printed URL into your browser to access the notebook. See the Getting Started for a full walkthrough.

Citing

If you used SpinToolkit in your research, please cite us:

@misc{sptk,
  author       = {{SpinToolkit Developers}},
  title        = {{SpinToolkit}},
  year         = {2026},
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.18948515},
  howpublished = {\url{https://github.com/spintoolkit-dev/SpinToolkit_py}}
}

To reference the LSW/GLSW calculations, please also include:

@article{XuL2026,
  author = {Xu, L. and Shi, X. and Jiao, Y. and Yang, J. and Yang, L. and Wang, Z.},
  title  = {In preparation},
  year   = {2026}
}