Metadata-Version: 2.4
Name: magnopy
Version: 0.3.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.9
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 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: wulfric==0.6.*,>=0.6.3
Provides-Extra: visual
Requires-Dist: matplotlib; extra == "visual"
Requires-Dist: plotly; extra == "visual"
Requires-Dist: wulfric[visual]==0.6.*,>=0.6.3; extra == "visual"
Dynamic: license-file

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

Magnopy is a Python package for the magnon-related properties:

* Ground state energy
* Energy minimization
* Linear Spin Wave theory and what comes from it

Please visit an extensive documentation on `magnopy.org <https://magnopy.org>`_ to find
out more.

Installation
============

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

.. code-block:: console

    pip install magnopy

Usage
=====

There are two ways to use magnopy:

* As a blackbox via `command line interface <https://docs.magnopy.org/en/latest/user-guide/index.html>`_
* As a `Python library <https://docs.magnopy.org/en/latest/user-guide/index.html>`_

User support
============

There are two ways to ask for help or give feedback

*   `Forum at google groups <https://groups.google.com/g/magnopy>`_

    You may send email directly to magnopy@googlegroups.com

*   `Github discussions <https://github.com/magnopy/magnopy/discussions>`_

    You may need to create an account at github to post a question.

Both are monitored by the authors, choose the one you prefer.

Development
===========

We welcome contributions to magnopy. If you would like to contribute, please
consult the `development guide <https://docs.magnopy.org/en/latest/development/index.html>`_
or contact the authors of the project.
