Find us on…

GitHub

PLUME


DOI

Plasma in a Linear Uniform Magnetized Environment

drawing drawing

PLUME is a parallelised numerical code that solves the Vlasov-Maxwell dispersion relation in hot (even relativistic) magnetised plasma.

If you use the code for a science publication, please provide the code website github.com/kgklein/PLUME in the acknowledgements of your publication, and cite the code:

@software{PLUME_2025,
  author       = {{Klein}, K. G. and
                  {Howes}, G. G.},
  title        = {kgklein/PLUME: Zenodo release},
  month        = April,
  year         = 2025,
  publisher    = {Zenodo},
  version      = {v1.0.1},
  doi          = {10.5281/zenodo.15215514},
  url          = {https://doi.org/10.5281/zenodo.15215514}
}

and code paper Klein, K. G., Howes, G. G., and Brown, C. R.: PLUME: Plasma in a Linear Uniform Magnetized Environment, RNAAS, 2025

Publications using the PLUME code can be found in our NASA ADS Library.

For first-time users, we recommend working through our PLUME Tutorial.

The key input parameters for PLUME are described on the PLUME Input page.

The output format of PLUME is described on the PLUME Output page.

Judging Energy Transfer in a - Plasma in a Linear Uniform Magnetized Environment

JetPlumeLogoDrawing

JET-PLUME is an extension to PLUME that predicts wave-particle energy transfer in velocity space using the field-particle correlation technique and linear theory. Please see the README for JET-PLUME.

JET-PLUME is operated in a similar manner to PLUME, either using command line or the python wrapper. See Section 4 above on how to operate and README for JET-PLUME for the additional inputs.

Details

If you use this code for a science publication, please provide the same code website as plume github.com/kgklein/PLUME in the acknowledgements of your publication and cite the code paper for JET-PLUME: ...

Python wrapper (linfpclib)

With the creation of JET-PLUME, a wrapper to use PLUME and JET-PLUME in a jupyter notebook was created. It aids in the creation of input files and running of the code with said input files. Please see the example notebook to see the key features of this wrapper. The use of the wrapper is entirely optional. NOTE: Please create and run notebooks from the main directory of the repository. This is necessary because the notebooks import key functions directly from the linfpclib module located there.

Developer Info

Kristopher Klein, Gregory Howes, Collin Brown