SpinWaveToolkit Documentation#

Warning

Needs to be updated.

SpinWaveToolkit is an open-source Python package which provides analytical tools for spin-wave physics and research. It consist of several models used in everyday calculations as well as of special tools for more advanced spin-wave modelling.

Features#

  • Calculation of the dispersion relation and derived quantities for several systems using analytical, semi-analytical, and numerical models. These include

    • single magnetic layer (thin film) surrounded by dielectrics,

    • coupled magnetic double layer (e.g. a synthetic antiferromagnet),

    • single magnetic layer inductively coupled to a superconducting layer from one side.

  • Simple magnetic material management using a Material class.

  • Functions for modelling Brillouin light scattering (BLS) signal and experiments.

Where to go#

For a quick introduction, jump to the Getting Started page and take a look at the provided Examples.

More information on the usage of SpinWaveToolkit is given in the User Guide.

Details about a specific element can be found at the API reference.

Cite us#

If you use SpinWaveToolkit in your work, please cite it as follows:

@online{swt,
    author = {Wojewoda, Ondřej and Klíma, Jan},
    title = {SpinWaveToolkit: Set of tools useful in spin wave research},
    year = {2025},
    publisher = {GitHub},
    version = {1.0.0},
    url = {https://github.com/CEITECmagnonics/SpinWaveToolkit},
    language = {en},
}

All sources of models used within the module are cited in their respective documentation. Consider citing them as well if you use these models.