https://github.com/magnopy/magnopy
Magnons with python
https://github.com/magnopy/magnopy
bosons holstein-primakoff magnetism magnon magnonics magnons solid-state-physics spin-hamiltonians spin-waves
Last synced: 25 days ago
JSON representation
Magnons with python
- Host: GitHub
- URL: https://github.com/magnopy/magnopy
- Owner: magnopy
- License: gpl-3.0
- Created: 2023-11-29T12:01:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-05-27T16:17:35.000Z (about 1 month ago)
- Last Synced: 2026-05-27T18:14:44.740Z (about 1 month ago)
- Topics: bosons, holstein-primakoff, magnetism, magnon, magnonics, magnons, solid-state-physics, spin-hamiltonians, spin-waves
- Language: Python
- Homepage: https://magnopy.org
- Size: 8.91 MB
- Stars: 10
- Watchers: 1
- Forks: 4
- Open Issues: 12
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
*******
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 `_
in **any**
`convention `_,
computes bosonic (magnon) Hamiltonian.
*************
Documentation
*************
Extensive documentation is available at `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 `_
or
`magnopy-lswt `_.
* For code examples see
`User guide `_.
* For full public API see
`API `_.
* To get some support and ask questions see
`User support `_.
* For summary of releases see
`Release notes `_.
************
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 `_.
***********
Development
***********
We welcome contributions to Magnopy. Pleas visit the
`development guide `_
or contact authors of the project to find out more.