1. Installation#

Currently you can either

(recommended) install latest release from PyPI via pip by typing in the command line

py -m pip install SpinWaveToolkit --user

or install from GitHub any branch via pip by typing in the command line

py -m pip install https://github.com/CEITECmagnonics/SpinWaveToolkit/tarball/<branch-name> --user

older installation approaches *(not recommended)*

or copy the SpinWaveToolkit folder to your site-packages folder manually. Usually (on Windows machines) located at

C:\Users\<user>\AppData\Roaming\Python\Python<python-version>\site-packages

for user-installed modules, or at

C:\<python-installation-folder>\Python<python-version>\Lib\site-packages

for global modules.

Note

This approach still works, since SpinWaveToolkit is a pure Python package without any compiled extensions. However, it is not recommended, since it does not automatically install dependencies.

1.1. Dependencies#

The SpinWaveToolkit package is compatible with Python >3.7, and uses the following modules:

numpy >1.20 (>2.0 is also ok, bugs be reported in Issues)
scipy >1.8

Note

If you encounter compatibility errors in contradiction with this list, let us know by posting your findings in a new Issue.