.. SpinWaveToolkit documentation master file, created by
   sphinx-quickstart on Tue Aug 12 12:25:37 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

SpinWaveToolkit Documentation
=============================


.. warning::
   .. :collapsible:
   
   Needs to be updated.


.. toctree::
   :maxdepth: 2
   :caption: Contents:
   :hidden:

   getting_started
   examples
   user_guide
   api_reference/index
   release_notes
   publications


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 :py:class:`.Material` class.
* Functions for modelling Brillouin light scattering (BLS) signal and experiments.


Where to go
-----------

.. grid:: 3

    .. grid-item-card::  :octicon:`rocket;6em;`
        :text-align: center

        For a quick introduction, jump to the :doc:`getting_started` page and take a look at the provided :doc:`examples`.

    .. grid-item-card:: :octicon:`book;6em;`
        :text-align: center

        More information on the usage of SpinWaveToolkit is given in the :doc:`user_guide`.

    .. grid-item-card:: :octicon:`log;6em;`
        :text-align: center

        Details about a specific element can be found at the :doc:`api_reference/index`.




.. _howtocite:

Cite us
-------

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

.. [1] Wojewoda, O., & Klíma, J. *SpinWaveToolkit: Set of tools useful in spin wave research.* GitHub, 2025. `<https://github.com/CEITECmagnonics/SpinWaveToolkit>`_


.. code-block:: bibtex

   @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.