.. _release-notes_0.2:

***********
Version 0.2
***********

.. warning::

    We recommend not to use this version of Magnopy due to :issue:`79`, that can affect
    some (not all) calculations of spin wave spectra. Use 0.4.2 and later instead.

0.2.1
=====
.. warning::

    We do not recommend to use :py:meth:`.Energy.optimize()` or :ref:`user-guide_cli_optimize-sd` of
    this version of Magnopy.

**Date** : 10 September 2025

Bugfix
------

* Fix problem with ``np.linalg.trace`` and with ``np.linalm.norm(..., axis=1)`` in
  :ref:`api_experimental` module.

0.2.0
=====

.. warning::

    We do not recommend to use :py:func:`.experimental.plot_spinham` of this version with
    old (<2.*) versions of |numpy|_.

    We do not recommend to use :py:meth:`.Energy.optimize()` or :ref:`user-guide_cli_optimize-sd` of
    this version of Magnopy.

**Date**: 10 September 2025



New features
------------

* :py:meth:`.Energy.optimize_generator`
* :py:class:`.PlotlyEngine`
* :py:meth:`.LSWT.G`
* :py:meth:`.SpinHamiltonian.add_dipole_dipole`
* ``no_html``, ``hide_personal_data``, ``spglib_symprec`` arguments in
  :py:func:`.scenarios.solve_lswt`.
* ``no_html``, ``hide_personal_data``, ``supercell`` arguments in
  :py:func:`.scenarios.optimize_sd`.
* ``-s, --supercell``, ``-no-html, --no-html``, ``-hpd, --hide-personal-data``
  in :ref:`user-guide_cli_optimize-sd`.
* ``-no-html, --no-html``, ``-hpd, --hide-personal-data``,
  ``-spg-s, --spglib-symprec``, ``-msdi, --make-sd-image`` in :ref:`user-guide_cli_lswt`.
* Output of "INITIAL_GUESS.txt", "SPIN_DIRECTIONS.html" and "SPIN_POSITIONS.txt"
  of the :ref:`user-guide_cli_optimize-sd` script.
* Output of "K-POINTS.html", "SPIN_VECTORS.txt", "HIGH-SYMMETRY_POINTS.txt",
  "K-POINTS.txt" and  "SPIN_DIRECTIONS.html" of the :ref:`user-guide_cli_lswt` script.
* Implement :ref:`api_experimental` module, where experimental features of Magnopy will be
  located. Those features might migrate to the core package in the future versions or be
  removed from it.
* :py:func:`.experimental.plot_spinham`
* :py:func:`.experimental.change_unit_cell`


Bug fixes
---------

* Fix :issue:`40`
* Fix a bug in :py:func:`.io.dump_vampire` - material index in .UCF file was always 0,
  now it varies when it should.

Improvements
------------

*   Make matplotlib and plotly optional dependencies. Use ``pip install "magnopy[visual]"``
    to be able to use plotting functions.


Breaking changes wrt 0.1
========================

Deprecated features
-------------------

* :py:func:`.io.output_k_resolved`


Removed features
----------------

* :py:meth:`.LSWT.G_inv`
* ``make_sd_image`` argument in :py:func:`.scenarios.solve_lswt` and
  :py:func:`.scenarios.optimize_sd`.