.. _sphx_glr_school-tutorials_trilmax-2025_1_python-library:

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

To get the most out of magnopy, use it as a python library. This tutorial teaches you how
to do so.

Every page of the tutorial explains a concept about |magnopy|_. There is a list of 
"Tutorial tasks", that can be found on top of each page. The tasks are meant for you to 
complete after reading the corresponding page and referenced materials.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="       Install magnopy        Check that you have version 0.2.1 available">

.. only:: html

  .. image:: /school-tutorials/trilmax-2025/1_python-library/images/thumb/sphx_glr_plot_1_introduction_thumb.png
    :alt:

  :ref:`sphx_glr_school-tutorials_trilmax-2025_1_python-library_plot_1_introduction.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="       Create a crystal structure for the material of your choice. Create a cell and a         set of atoms. For each atom specify all properties mentioned on this page.        (extra) Visualize created structure using :pymagnopy.PlotlyEngine     *   (extra) Compute conventional and primitive cell of your structure (see         :pywulfric.crystal.get_primitive and         :pywulfric.crystal.get_conventional). Visualize them. Are they the same?         Is it true for all crystals?">

.. only:: html

  .. image:: /school-tutorials/trilmax-2025/1_python-library/images/thumb/sphx_glr_plot_2_crystal_thumb.png
    :alt:

  :ref:`sphx_glr_school-tutorials_trilmax-2025_1_python-library_plot_2_crystal.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="       Create an instance of :external:pymagnopy.Convention for every         mathematical formula on this page.        (extra) Write down the spin Hamiltonian in the convention that you usually use         or seen recently. Create an instance of the :pymagnopy.Convention that         describes it.">

.. only:: html

  .. image:: /school-tutorials/trilmax-2025/1_python-library/images/thumb/sphx_glr_plot_3_convention_thumb.png
    :alt:

  :ref:`sphx_glr_school-tutorials_trilmax-2025_1_python-library_plot_3_convention.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="       Create a spin Hamiltonian of the orthorhombic ferromagnet with three magnetic axes         (easy, medium and hard).        Change convention of the spin Hamiltonian. Inspect how (if?) the parameters are         changing when you do so.        Add some magnetic field to the Hamiltonian. Check the values of the Hamiltonian&#x27;s         parameters that store the magnetic field.        Add magnetic dipole-dipole interaction. Test both energy and distance cut-offs.         Which parameters of the spin Hamiltonian store magnetic dipole-dipole interaction?">

.. only:: html

  .. image:: /school-tutorials/trilmax-2025/1_python-library/images/thumb/sphx_glr_plot_4_spinham_thumb.png
    :alt:

  :ref:`sphx_glr_school-tutorials_trilmax-2025_1_python-library_plot_4_spinham.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip=" .. admonition:: Tutorial tasks">

.. only:: html

  .. image:: /school-tutorials/trilmax-2025/1_python-library/images/thumb/sphx_glr_plot_5_energy_thumb.png
    :alt:

  :ref:`sphx_glr_school-tutorials_trilmax-2025_1_python-library_plot_5_energy.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip=" .. admonition:: Tutorial tasks">

.. only:: html

  .. image:: /school-tutorials/trilmax-2025/1_python-library/images/thumb/sphx_glr_plot_6_wulfric_thumb.png
    :alt:

  :ref:`sphx_glr_school-tutorials_trilmax-2025_1_python-library_plot_6_wulfric.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">(extra) K-points with wulfric</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="     Use one of the spin Hamiltonians from the previous tutorial and compute all terms       of the magnon Hamiltonian.      Compute magnon dispersion of a simple ferromagnet.     * Compute magnon dispersion of a simple antiferromagnet.">

.. only:: html

  .. image:: /school-tutorials/trilmax-2025/1_python-library/images/thumb/sphx_glr_plot_7_lswt_thumb.png
    :alt:

  :ref:`sphx_glr_school-tutorials_trilmax-2025_1_python-library_plot_7_lswt.py`

.. raw:: html

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


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /school-tutorials/trilmax-2025/1_python-library/plot_1_introduction
   /school-tutorials/trilmax-2025/1_python-library/plot_2_crystal
   /school-tutorials/trilmax-2025/1_python-library/plot_3_convention
   /school-tutorials/trilmax-2025/1_python-library/plot_4_spinham
   /school-tutorials/trilmax-2025/1_python-library/plot_5_energy
   /school-tutorials/trilmax-2025/1_python-library/plot_6_wulfric
   /school-tutorials/trilmax-2025/1_python-library/plot_7_lswt