Metadata-Version: 2.4
Name: magnopy
Version: 0.6.0
Summary: Magnopy is a Python package for magnons.
Author-email: Andrey Rybakov <rybakov.ad@icloud.com>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://magnopy.org
Project-URL: Documentation, https://magnopy.org
Project-URL: Repository, https://github.com/magnopy/magnopy.git
Project-URL: Issues, https://github.com/magnopy/magnopy/issues
Project-URL: Changelog, https://magnopy.org/en/latest/release-notes/index.html
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy~=2.0
Requires-Dist: wulfric~=0.7
Provides-Extra: visual
Requires-Dist: matplotlib; extra == "visual"
Requires-Dist: plotly; extra == "visual"
Requires-Dist: wulfric[visual]~=0.7; extra == "visual"
Dynamic: license-file

*******
Magnopy
*******

Spin Hamiltonian, ground state, magnons.

.. image:: https://badge.fury.io/py/magnopy.svg
   :target: https://badge.fury.io/py/magnopy/

.. image:: https://readthedocs.org/projects/magnopy/badge/?version=latest
   :target: https://magnopy.org/en/latest/?badge=latest
   :alt: Documentation Status

.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
   :target: https://www.gnu.org/licenses/gpl-3.0

.. image:: https://results.pre-commit.ci/badge/github/magnopy/magnopy/main.svg
   :target: https://results.pre-commit.ci/latest/github/magnopy/magnopy/main
   :alt: pre-commit.ci status

****************
What is Magnopy?
****************

Magnopy is a python code that, given
`spin Hamiltonian <https://docs.magnopy.org/en/latest/user-guide/theory-behind/spin-hamiltonian.html>`_
in **any**
`convention <https://docs.magnopy.org/en/latest/user-guide/theory-behind/convention.html>`_,
computes bosonic (magnon) Hamiltonian.

*************
Documentation
*************

Extensive documentation is available at `magnopy.org <https://magnopy.org>`_.

Magnopy can be used both as a Python library and as a command line tool.

* For details about black box style usage see
  `magnopy-optimize-sd <https://docs.magnopy.org/en/latest/user-guide/cli/magnopy-optimize-sd/index.html>`_
  or
  `magnopy-lswt <https://docs.magnopy.org/en/latest/user-guide/cli/magnopy-lswt/index.html>`_.
* For code examples see
  `User guide <https://docs.magnopy.org/en/latest/user-guide/index.html>`_.
* For full public API see
  `API <https://docs.magnopy.org/en/latest/api/index.html>`_.
* To get some support and ask questions see
  `User support <https://docs.magnopy.org/en/latest/user-support/index.html>`_.
* For summary of releases see
  `Release notes <https://docs.magnopy.org/en/latest/release-notes/index.html>`_.

************
Installation
************

To install Magnopy run (you may need to use ``pip3``):

.. code-block:: console

    pip install magnopy

To install with visualization capabilities (recommended) run (you may need to use
``pip3``):

.. code-block:: console

  pip install "magnopy[visual]"

************
User support
************

If you have a question about Magnopy, have an idea for its improvement, or found a bug,
please do not hesitate to contact us via one of the
`support channels <https://docs.magnopy.org/en/latest/user-support/index.html>`_.

***********
Development
***********

We welcome contributions to Magnopy. Pleas visit the
`development guide <https://docs.magnopy.org/en/latest/development/index.html>`_
or contact authors of the project to find out more.
