Add KPM to README and update links

README.md

@@ -43,11 +43,12 @@ Sunny is inspired by SpinW, especially regarding symmetry analysis and tradition
 | -- | -- | -- | -- |
 | Symmetry-guided modeling | ❌ | ✅ | ✅ |
 | Interactive graphics | ❌ | ✅ | ✅ |
-| [Incommensurate spiral order](https://arxiv.org/abs/1402.6069) | ❌ | ✅ | ✅ |
-| Arbitrary couplings of quantum operators | ✅ | ❌ | ✅ |
-| [Interaction renormalization corrections](https://arxiv.org/abs/2304.03874) | ❌ | ❌ | ✅ |
-| [Multi-flavor spin wave theory](https://arxiv.org/abs/1307.7731) | ✅ | ❌ | ✅ |
-| [Classical SU(_N_) spin dynamics](https://arxiv.org/abs/2209.01265) | ❌ | ❌ | ✅ |
+| [Incommensurate spiral order](https://sunnysuite.github.io/Sunny.jl/stable/examples/spinw/SW15_Ba3NbFe3Si2O14.html) | ❌ | ✅ | ✅ |
+| Arbitrary coupling of quantum operators | ✅ | ❌ | ✅ |
+| [Interaction renormalization corrections](https://sunnysuite.github.io/Sunny.jl/stable/renormalization.html) | ❌ | ❌ | ✅ |
+| [Multi-flavor spin wave theory](https://sunnysuite.github.io/Sunny.jl/stable/examples/03_LSWT_SU3_FeI2.html) | ✅ | ❌ | ✅ |
+| [Linear-scaling spin wave theory](https://sunnysuite.github.io/Sunny.jl/stable/examples/09_Disorder_KPM.html) | ❌ | ❌ | ✅ |
+| [Classical SU(_N_) spin dynamics](https://sunnysuite.github.io/Sunny.jl/stable/examples/04_GSD_FeI2.html) | ❌ | ❌ | ✅ |
 | [Fast long-range dipole interactions](https://sunnysuite.github.io/Sunny.jl/stable/examples/07_Dipole_Dipole.html) | ❌ | ❌ | ✅ |
 | Programming language | C++ | Matlab | [Julia](https://julialang.org/) |
 

examples/09_Disorder_KPM.jl

@@ -1,14 +1,14 @@
 # # 9. Disordered system with KPM
 #
-# This example uses the kernel polynomial method (KPM) to efficiently calculate
-# the neutron scattering spectrum of a disordered triangular antiferromagnet.
-# The model is inspired by YbMgGaO4, as studied in [Paddison et al, Nature
-# Phys., **13**, 117–122 (2017)](https://doi.org/10.1038/nphys3971) and [Zhu et
-# al, Phys. Rev. Lett. **119**, 157201
-# (2017)](https://doi.org/10.1103/PhysRevLett.119.157201). Disordered occupancy
-# of non-magnetic Mg/Ga sites can be modeled as a stochastic distribution of
-# exchange constants and ``g``-factors. Including this disorder introduces
-# broadening of the spin wave spectrum.
+# This example uses the [kernel polynomial method](@ref SpinWaveTheoryKPM) to
+# efficiently calculate the neutron scattering spectrum of a disordered
+# triangular antiferromagnet. The model is inspired by YbMgGaO4, as studied in
+# [Paddison et al, Nature Phys., **13**, 117–122
+# (2017)](https://doi.org/10.1038/nphys3971) and [Zhu et al, Phys. Rev. Lett.
+# **119**, 157201 (2017)](https://doi.org/10.1103/PhysRevLett.119.157201).
+# Disordered occupancy of non-magnetic Mg/Ga sites can be modeled as a
+# stochastic distribution of exchange constants and ``g``-factors. Including
+# this disorder introduces broadening of the spin wave spectrum.
 
 using Sunny, GLMakie
 

examples/spinw_tutorials/SW15_Ba3NbFe3Si2O14.jl

@@ -3,6 +3,9 @@
 # This is a Sunny port of [SpinW Tutorial
 # 15](https://spinw.org/tutorials/15tutorial), originally authored by Sandor
 # Toth. It calculates the linear spin wave theory spectrum of Ba₃NbFe₃Si₂O₁₄.
+# The ground state is an incommensurate spiral, which can be directly studied
+# using the functions [`minimize_spiral_energy!`](@ref) and
+# [`SpinWaveTheorySpiral`](@ref).
 
 # Load packages