:orphan:

.. _master-tutorial:

****************
Master tutorial
****************


**Target magnopy's version**: |version|

**Last updated**: 9 January 2026


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Magnopy as a python library
===========================

Every page of the tutorial explains some concepts about the |magnopy|_. There is a list
of exercises on top of each tutorial page. Exercises are connected to the content that you
find in each page. 




.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="    We recommend to install magnopy with its visual capabilities whenever possible     (magnopy[visual]). Magnopy will output graphics by default if |plotly|_ and     |matplotlib|_ are installed. Nevertheless, graphical libraries are not included as     default dependencies in order to offer computational capabilities of magnopy even if     those libraries are not available.">

.. only:: html

  .. image:: /master-tutorial/1_python-library/images/thumb/sphx_glr_plot_0_introduction_thumb.png
    :alt:

  :doc:`/master-tutorial/1_python-library/plot_0_introduction`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Introducing magnopy</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Every spin Hamiltonian in |magnopy|_ is defined on a lattice and a set of magnetic centers in its unit cell. In other words, one needs to define a crystal structure in order to define the spin Hamiltonian. This tutorial explains how to do that.">

.. only:: html

  .. image:: /master-tutorial/1_python-library/images/thumb/sphx_glr_plot_1_crystal_thumb.png
    :alt:

  :doc:`/master-tutorial/1_python-library/plot_1_crystal`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Crystal structure</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Before we move on to the Hamiltonian itself it is very important to understand that there is a dozen of different conventions of essentially the same type of Hamiltonian present in the literature. Here are a few examples of different conventions for the isotropic exchange term">

.. only:: html

  .. image:: /master-tutorial/1_python-library/images/thumb/sphx_glr_plot_2_convention_thumb.png
    :alt:

  :doc:`/master-tutorial/1_python-library/plot_2_convention`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Convention of spin Hamiltonian</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Now we are ready to discuss :pymagnopy.SpinHamiltonian.">

.. only:: html

  .. image:: /master-tutorial/1_python-library/images/thumb/sphx_glr_plot_3_spinham_thumb.png
    :alt:

  :doc:`/master-tutorial/1_python-library/plot_3_spinham`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Spin Hamiltonian</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Magnetic field is an external effect. However, magnopy, perhaps counterintuitively, stores it as an interaction parameter of the type :pymagnopy.SpinHamiltonian.p1, i. e. one spin and one site parameter.">

.. only:: html

  .. image:: /master-tutorial/1_python-library/images/thumb/sphx_glr_plot_4_magnetic_field_thumb.png
    :alt:

  :doc:`/master-tutorial/1_python-library/plot_4_magnetic_field`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Magnetic field</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Magnetic dipole-dipole interaction can be written as a two-spin/two-sites parameter. To save the burden of manual conversion, magnopy has a convenience method that adds magnetic dipole-dipole interaction to the spin Hamiltonian.">

.. only:: html

  .. image:: /master-tutorial/1_python-library/images/thumb/sphx_glr_plot_5_dipdip_thumb.png
    :alt:

  :doc:`/master-tutorial/1_python-library/plot_5_dipdip`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Magnetic dipole-dipole interaction</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip=" Classical energy of the spin Hamiltonian is implemented in a separate class.">

.. only:: html

  .. image:: /master-tutorial/1_python-library/images/thumb/sphx_glr_plot_6_energy_thumb.png
    :alt:

  :doc:`/master-tutorial/1_python-library/plot_6_energy`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Classical Energy</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="For the upcoming tutorials we need to be able to generate a set of k-points. In particular, a set of k-points for the k-path between high-symmetry points. There is a number of ways to do so and a number of packages out there that can deal with such a task. Magnopy use one of them, |wulfric|_, as a dependency for k-points, symmetry analysis (powered by |spglib|_) and visualization (powered by |plotly|_).">

.. only:: html

  .. image:: /master-tutorial/1_python-library/images/thumb/sphx_glr_plot_7_wulfric_thumb.png
    :alt:

  :doc:`/master-tutorial/1_python-library/plot_7_wulfric`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">(extra) Wulfric</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="All methods for linear spin-wave theory are grouped in the :pymagnopy.LSWT class.">

.. only:: html

  .. image:: /master-tutorial/1_python-library/images/thumb/sphx_glr_plot_8_lswt_thumb.png
    :alt:

  :doc:`/master-tutorial/1_python-library/plot_8_lswt`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Linear Spin Wave theory</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Magnopy as a black box
======================

Alternative way to use magnopy, that does not require knowledge of Python is through
its command line interface.

.. hint::
    The command line scripts can be run from within python as well, see:
    |magnopy-scenarios|_. One can study the source code of
    :external:py:func:`magnopy.scenarios.optimize_sd` and
    :external:py:func:`magnopy.scenarios.solve_lswt` for more advance example of how
    magnopy can be used as a python library.






.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This page explains how to use optimize spin direction via numerical minimization. See docs for |magnopy-optimize-sd|_ for full list of supported arguments. On this page we give examples of how to use the script and text and files that it can produce.">

.. only:: html

  .. image:: /master-tutorial/2_black-box/images/thumb/sphx_glr_plot-1-optimize-sd_thumb.png
    :alt:

  :doc:`/master-tutorial/2_black-box/plot-1-optimize-sd`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">magnopy-optimize-sd</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This page explains how to use optimize spin direction via numerical minimization. See docs for |magnopy-lswt|_ for full list of supported arguments. On this page we give examples of how to use the script and text and files that it can produce.">

.. only:: html

  .. image:: /master-tutorial/2_black-box/images/thumb/sphx_glr_plot-2-lswt_thumb.png
    :alt:

  :doc:`/master-tutorial/2_black-box/plot-2-lswt`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">magnopy-lswt</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Solutions for the exercises
===========================




.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Introducing magnopy">

.. only:: html

  .. image:: /master-tutorial/3_exercises/images/thumb/sphx_glr_plot_0_introduction_thumb.png
    :alt:

  :doc:`/master-tutorial/3_exercises/plot_0_introduction`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Introducing magnopy</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="We will use the fictitious crystal with the lattice vectors">

.. only:: html

  .. image:: /master-tutorial/3_exercises/images/thumb/sphx_glr_plot_1_crystal_thumb.png
    :alt:

  :doc:`/master-tutorial/3_exercises/plot_1_crystal`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Crystal structure</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Convention of spin Hamiltonian">

.. only:: html

  .. image:: /master-tutorial/3_exercises/images/thumb/sphx_glr_plot_2_convention_thumb.png
    :alt:

  :doc:`/master-tutorial/3_exercises/plot_2_convention`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Convention of spin Hamiltonian</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Spin Hamiltonian">

.. only:: html

  .. image:: /master-tutorial/3_exercises/images/thumb/sphx_glr_plot_3_spinham_thumb.png
    :alt:

  :doc:`/master-tutorial/3_exercises/plot_3_spinham`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Spin Hamiltonian</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Magnetic field">

.. only:: html

  .. image:: /master-tutorial/3_exercises/images/thumb/sphx_glr_plot_4_magnetic_field_thumb.png
    :alt:

  :doc:`/master-tutorial/3_exercises/plot_4_magnetic_field`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Magnetic field</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Classical Energy">

.. only:: html

  .. image:: /master-tutorial/3_exercises/images/thumb/sphx_glr_plot_6_energy_thumb.png
    :alt:

  :doc:`/master-tutorial/3_exercises/plot_6_energy`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Classical Energy</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="(extra) Wulfric">

.. only:: html

  .. image:: /master-tutorial/3_exercises/images/thumb/sphx_glr_plot_7_wulfric_thumb.png
    :alt:

  :doc:`/master-tutorial/3_exercises/plot_7_wulfric`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">(extra) Wulfric</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Linear Spin Wave theory">

.. only:: html

  .. image:: /master-tutorial/3_exercises/images/thumb/sphx_glr_plot_8_lswt_thumb.png
    :alt:

  :doc:`/master-tutorial/3_exercises/plot_8_lswt`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Linear Spin Wave theory</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /master-tutorial/1_python-library/index.rst
   /master-tutorial/2_black-box/index.rst
   /master-tutorial/3_exercises/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: master-tutorial_python.zip </master-tutorial/master-tutorial_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: master-tutorial_jupyter.zip </master-tutorial/master-tutorial_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_