Skip to content

JuliaSpacePhysics/PlasmaWaves.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PlasmaWaves

DOI version

Build Status Coverage

Wave analysis for (space) plasmas, built in Julia.

Installation: at the Julia REPL, run using Pkg; Pkg.add("PlasmaWaves")

Documentation: Dev

Features and Roadmap

  • Wave polarization analysis with degree of polarization, wave normal angle, helicity, ellipticity, and planarity metrics
  • Wave propagation analysis
    • SVD of the magnetic spectral matrix
    • Electromagnetic SVD
  • Wave dispersion relation analysis

Quick start

using PlasmaWaves

# X is an N×3 array of field-aligned magnetic fluctuations
res = wavpol(X, fs = 128.0; nfft = 256)

res.degpol    # degree of polarization across time-frequency bins
res.waveangle # wave normal angle estimates

For SVD-derived planarity metrics, call wavpol_svd or twavpol_svd.

⚠️ Development Status: This package is in active development. While functional, the functionality is not fully tested (it has been cross-validated with a Python implementation in PySPEDAS) and the API may undergo changes in future releases. Please test thoroughly before using in scientific work.

About

Wave analysis for (space) plasmas

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages