Analysis tools for particle velocity distribution functions (VDFs).
Installation: at the Julia REPL, run using Pkg; Pkg.add("VelocityDistributionFunctions")
Start with the MMS ion moments example to adapt a calibrated particle distribution.
- Angles are in degrees and give the particle velocity direction in physics spherical coordinates:
θis the polar angle fromẑ(0–180°),φthe azimuth fromx̂(0–360°).
| name | meaning |
|---|---|
pitch_angle_distribution(vdf, B, φ, θ; bins = 12, method = :mean) |
pitch-angle distribution of vdf[φ, θ(, energy)], bins a count or edges; returns (; data, pitch_angles) |
tpitch_angle_distribution(vdf, B, φ, θ; bins, method) |
the same with a trailing time dimension on vdf, B, and optionally on φ, θ |
EnergyAngleGrid(energy, phi, theta; layout, denergy, dphi, dtheta) |
spherical velocity-space grid; layout names the data axes, e.g. (:phi, :theta, :energy) |
plasma_moments(data, grid; species, units, sc_pot = 0, B = nothing) |
moments of one distribution; field-aligned quantities when B is given |
tmoments(data, grid; species, units, sc_pot, B, tdim = ndims(data)) |
plasma_moments per time slice, as a StructArray; vector arguments give one value per time |
directional_energy_spectra(S, pitch_angles, loss_cone; half_sector_width, para_tol = 0, perp_tol = 0) |
omni, parallel, antiparallel and perpendicular energy spectra (; omni, para, anti, perp) of S[pitch, energy, time] |
| below | public, not exported |
pitch_angle_spectra(S, dE, min_channels, max_channels) |
for each channel range min_channels[i]:max_channels[i], the dE-weighted mean of S[pitch, energy, time] over energy, skipping non-finite values, as [pitch, time] |
- Fitting analytic distribution models (bi-Maxwellian, bi-kappa, …) to data
- Generate pitch-angle distributions (PADs) from VDFs
- New PADs by averaging over multiple energy channels
- Generate directional flux spectra (omni-, parallel, antiparallel, and perpendicular directions) from PADs
- Energy/gyro-phase spectra
- Plasma moments (density, velocity, pressure, temperature, heat flux) from 3D distributions
- Extend to simulation data
- Volume visualization : scatter, volume, isosurface modes...
- Dispersion analysis (see also PlasmaWaves.jl)
- Validation and Benchmarks
- plasmapy.distributions
- ISEE_3D: Visualization tool for three-dimensional plasma velocity distributions
- Bulk Flow Velocity Changing Software - Lynn B. Wilson
- SPEDAS Particle Tools Development Guide
- PySPEDAS
- mms.mms_part_getspec: Generate spectra and moments from 3D MMS particle data
- erg_analysis: Arase (ERG) Particle Tools
- pyrfu: Python package for working with Magnetospheric MultiScale (MMS) mission data
- SpectralFitting.jl: Fast and flexible spectral fitting in Julia.
- GDF: gyrotorpic distribution functions, Slepian basis function based reconstructions to recover distribution functions