LUME-WarpX

LUME-WarpX is a LUME-compatible wrapper for WarpX, the exascale particle-in-cell code for accelerator, plasma, and laser-plasma simulations.

It exposes a single WarpX class that:

• builds a complete WarpX/PICMI simulation from a declarative YAML input file — grid, field solver, applied fields, particle species, and diagnostics;

• runs the simulation through the familiar LUME configure / run lifecycle;

• archives and restores the full input and openPMD output to a single HDF5 file; and

• plots fields and particle phase space directly from the openPMD diagnostics, backed by openPMD-beamphysics.

Note

Development is in progress. WarpX (pywarpx) is not available on PyPI and must be built from source — see Installation.

Contents

• Installation
  • 1. Install WarpX / pywarpx
  • 2. Install LUME-WarpX
  • Requirements
• Quickstart
  • Usage
  • Constructor options
  • Working with output
• Configuration (YAML input)
  • grid
  • solver
  • simulation
  • fields
  • species
  • diagnostics
• Plotting & analysis
  • plot_fields — field maps
  • plot1D — statistic vs. coordinate
  • plot2D — phase space
  • Selecting particles
• Archiving & restoring
  • Archiving
  • Restoring
• Examples
  • 150 keV thermionic electron gun
  • 1-D Pierce diode (Child-Langmuir limit)
  • Beam-driven plasma wakefield acceleration (3-D)
  • Uniform thermal plasma

Quick example

from warpx import WarpX

w = WarpX(input_file="gun.yaml", path="./output", verbose=True)
w.run()  # configures, steps the simulation, and loads every diagnostic

w.plot2D("z", "kinetic_energy")   # longitudinal phase space
w.plot1D("t", "mean_z")           # beam centroid vs. time
w.plot_fields("phi", "x", "z")    # electrostatic potential map

Acknowledgements

This research used the open-source particle-in-cell code WarpX. Primary WarpX contributors are with LBNL, LLNL, CEA-LIDYL, SLAC, DESY, CERN, Helion Energy, TAE Technologies, and Realta Fusion. We acknowledge all WarpX contributors.

LUME

C. E. Mayes, P. H. Fuoss, J. R. Garrahan, H. Slepicka, A. Halavanau, J. Krzywinski, A. L. Edelen, F. Ji, W. Lou, N. R. Neveu, A. Huebl, R. Lehe, L. Gupta, C. M. Gulliford, D. C. Sagan, J. C. E, and C. Fortmann-Grote, “Lightsource unified modeling environment (LUME), a start-to-end simulation ecosystem,” in Proc. of IPAC, 2021, pp. THPAB217.

WarpX

J.-L. Vay et al., WarpX: An advanced Particle-In-Cell code. DOI:10.5281/zenodo.4571577, https://blast-warpx.github.io (2018).