Welcome

Sunny is a package for simulating magnetic materials in and out of equilibrium. It facilitates the development of theoretical models that can be quantitatively compared to experimental data such as scattering intensities.

Feature highlights include symmetry-guided modeling, interactive visualization, and careful treatment of quantum spin effects.

Browse the tutorials to get started. See also SpinW ports for traditional spin wave theory.

Library Reference lists all public functions.

If you find Sunny useful, please cite the main JOSS paper and any relevant methodology papers. If any issues or questions arise, don't hesitate to ask on the #helpdesk channel of the Sunny Slack workspace.