Installation

Requirements

Before installing Magnon, please make sure your Python version and packages meet the requirements for

  • Python (version 3.13 or newer)

  • NumPy - for vectorised array handling (version 2.1 or newer)

  • Matplotlib - for plotting (version 3.9.2 or newer)

  • Atomic Simulation Environment - for handling crystal structure data (version 3.23 or newer)

  • Spglib - to get crystal symmetries (version 2.5 or newer)

all of which are available through the standard package repositories (such as PyPI).

PyPI (pip install)

Magnon is most easily installed using the Python Package Index using:

pip install --upgrade magnon

conda-forge

If you prefer installation via the Conda package manager, you may use:

conda install conda-forge::magnon

Source code (tarball)

To install from a compressed source code file, start by downloading the latest tarball from [link]

Then extract the files, and create a symbolic link:

tar -xf [filename].tar.gz
$ ln -s [filename] magnon

Thanks to the symbolic link, we can install using PyPI as:

pip install /path/to/magnon