Data

Tools

Indexes

Applications

Experiments

Open Source Science

spinwavetoolkit

Set of tools useful in spin wave research.

https://github.com/ceitecmagnonics/spinwavetoolkit

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.9%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Set of tools useful in spin wave research.

Basic Info
Statistics
  • Stars: 6
  • Watchers: 1
  • Forks: 3
  • Open Issues: 13
  • Releases: 3
Created about 2 years ago · Last pushed 10 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

SpinWaveToolkit

SpinWaveToolkit is an open-source Python package which provides analytical tools for spin-wave physics and research.

[!TIP] This package could use some updating. If you want to contrubute, see CONTRIBUTING GUIDELINES.

Installation

Currently you can either 1. (recommended) install latest release from PyPI via pip by typing in the command line py -m pip install SpinWaveToolkit --user 2. 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)

  1. 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.

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.

About

This package provides analytical tools in spin-wave physics. This section gives an overview of its capabilites. All functionalities are described in the SpinWaveToolkit Documentation.

Features: - Calculation of the dispersion relation and derived quantities for several systems using analytical, semi-analytical, and numerical models. These include - single magnetic layer (thin film) surrounded by dielectrics [^1] [^2], - coupled magnetic double layer (e.g. a synthetic antiferromagnet) [^3], - single magnetic layer inductively coupled to a superconducting layer from one side [^4]. - Simple magnetic material management using a Material class. - Functions for modelling Brillouin light scattering (BLS) signal and experiments.

Example

Example of calculation of the spin-wave dispersion relation f(k_xi), and other important quantities, for the lowest-order mode in a 30 nm thick NiFe (Permalloy) layer. ```Python import numpy as np import SpinWaveToolkit as SWT

kxi = np.linspace(1e-6, 150e6, 150)

PyChar = SWT.SingleLayer(Bext=20e-3, kxi=kxi, theta=np.pi/2, phi=np.pi/2, d=30e-9, weff=2e-6, boundary_cond=2, material=SWT.NiFe) DispPy = PyChar.GetDispersion()1e-9/(2np.pi) # GHz vgPy = PyChar.GetGroupVelocity()1e-3 # km/s lifetimePy = PyChar.GetLifetime()1e9 # ns decLen = PyChar.GetDecLen()*1e6 # um ``` For more examples (with images) look here.

Cite us

If you use SpinWaveToolkit in your work, please cite it as follows:

[1] Wojewoda, O., & Klíma, J. SpinWaveToolkit: Set of tools useful in spin wave research. GitHub, 2025. https://github.com/CEITECmagnonics/SpinWaveToolkit

BibTeX entry: BibTeX @online{swt, author = {Wojewoda, Ondřej and Klíma, Jan}, title = {SpinWaveToolkit: Set of tools useful in spin wave research}, year = {2025}, publisher = {GitHub}, version = {1.0.0}, url = {https://github.com/CEITECmagnonics/SpinWaveToolkit}, language = {en}, }

All sources of models used within the SpinWaveToolkit are cited in their respective documentation. Consider citing them as well if you use these models.

[^1]: B. A. Kalinikos and A. N. Slavin, J. Phys. C: Solid State Phys., 19, 7013 (1986). [^2]: S. Tacchi et al., Phys. Rev. B, 100, 104406 (2019). [^3]: R. A. Gallardo et al., Phys. Rev. Applied, 12, 034012 (2019). [^4]: X.-H. Zhou et al., Phys. Rev. B, 110, L020404 (2024).

Owner

  • Name: CEITECmagnonics
  • Login: CEITECmagnonics
  • Kind: organization

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: SpinWaveToolkit
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Ondřej
    family-names: Wojewoda
  - given-names: Jan
    family-names: Klíma
repository-code: 'https://github.com/CEITECmagnonics/SpinWaveToolkit'
date-released: '2025-03-09'

GitHub Events

Total
  • Create event: 11
  • Commit comment event: 2
  • Release event: 3
  • Issues event: 10
  • Watch event: 3
  • Delete event: 12
  • Member event: 3
  • Issue comment event: 13
  • Push event: 134
  • Pull request review event: 3
  • Pull request event: 9
  • Fork event: 2
Last Year
  • Create event: 11
  • Commit comment event: 2
  • Release event: 3
  • Issues event: 10
  • Watch event: 3
  • Delete event: 12
  • Member event: 3
  • Issue comment event: 13
  • Push event: 134
  • Pull request review event: 3
  • Pull request event: 9
  • Fork event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 10
  • Total pull requests: 6
  • Average time to close issues: 8 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 1.3
  • Average comments per pull request: 0.33
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 7
  • Pull requests: 6
  • Average time to close issues: 2 days
  • Average time to close pull requests: 3 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.14
  • Average comments per pull request: 0.33
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • GiovanniKl (24)
Pull Request Authors
  • GiovanniKl (6)
  • OndrejW (2)
Top Labels
Issue Labels
enhancement (6) example/use case (3) question (3) bug (2) documentation (1)
Pull Request Labels
enhancement (1) question (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 336 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
pypi.org: spinwavetoolkit

Set of tools useful in spin wave research.

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 336 Last month
Rankings
Dependent packages count: 8.7%
Forks count: 20.3%
Stargazers count: 23.3%
Average: 25.4%
Dependent repos count: 49.1%
Maintainers (1)
GiovanniKl
Last synced: 10 months ago

Dependencies

environment.yml pypi