Release Notes#

Tip

For more information, see the Releases on GitHub.

Version 1.2.1#

2026-02-23

Patch featuring important dispersion-model fixes and small tweaks.

All GetBlochFunction() methods now include optional weighting by Bose-Einstein distribution.
New physical constant - Planck constant H - added to the module.

Anisotropy tensor in SingleLayer is now correctly handled for dispersion relation calculations.
Correct formula for ellipticity use in SingleLayer.
Docstring fixes and minor improvements, mainly in DoubleLayerNumeric.
BLS example now includes also first PSSW mode and usage of BE distribution (see Modeling BLS signal from single magnetic layer).
Documentation improvements.
Instructions in CONTRIBUTING.md updated.

2025-11-12

Dispersion model fixes and static magnetization problem solver.

All BLS-related functions moved to a separate submodule bls. It will be extended in future releases.
bls.getBLSsignal() now returns also the polarization induced in the ferromagnetic film.
Added static magnetization solver MacrospinEquilibrium for finding the equilibrium orientation of the magnetization in a ferromagnetic film under an applied magnetic field and uniaxial anisotropies. This can be used to find the angle of magnetization before calculating the spin-wave dispersion. For this, helper functions sphr2cart() and cart2sphr() were added as well as an example notebook (see Static magnetization equilibrium and hysteresis loops).
Added a dependency on the (lightweight) tqdm package for progress bars.
Class SingleLayer now supports dispersion calculation with the static magnetization at an arbitrary angle to the film plane and with any uniaxial anisotropy.

Instructions in CONTRIBUTING.md updated.
SingleLayerNumeric now notifies the user if the used geometry is valid, referring to the partially-out-of-plane magnetization, which is not currently supported. (We hope to fix this in future releases.)
Docstring fixes and minor improvements.
Documentation improvements.

2025-08-26

A small patch mostly related to documentation.

2025-08-21

Improving the module!

Added functions for basic Brillouin light scattering (BLS) intensity calculations.
Added method GetBlochFunction to all dispersion models. This is used in the BLS modelling functions. Can be used also for PSWS spectra (planned).
Added dispersion model for a single film coupled to a superconducting layer (SingleLayerSCcoupled), only for DE spin waves for now.
Added dispersion model for magnon-polaritons in bulk ferromagnets (BulkPolariton).
Added documentation.
Release to PyPI.
Class SingleLayerNumeric extended from 3 to an arbitrary number of modes.

Fixed a bug in SingleLayerNumeric that caused incorrect results for nonzero KuOOP.
Removed irrelevant parameter nc from SingleLayer in zeroth perturbation methods.
Update of parametric pumping methods within SingleLayer.
Docstring fixes and minor improvements.

2025-03-09

The first release of a reworked SWT. Fully functional with a hopefully stable syntax.