diff options
Diffstat (limited to 'Python/pywarpx/WarpXPIC.py')
| -rw-r--r-- | Python/pywarpx/WarpXPIC.py | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Python/pywarpx/WarpXPIC.py b/Python/pywarpx/WarpXPIC.py index dc66ec26a..66930d81f 100644 --- a/Python/pywarpx/WarpXPIC.py +++ b/Python/pywarpx/WarpXPIC.py @@ -4,6 +4,13 @@ # # License: BSD-3-Clause-LBNL +# The WarpXPIC class is the beginnings of an implementation of a standard interface +# for running PIC codes. This is the run time equivalent to the PICMI standard. +# This standard would specify the API for calling the various pieces of typical +# time step loops, for example get_self_fields and put_Efields. Ideally, a user +# could write a loop using the standard and, importing one of compliant codes, be +# able to run a customized PIC simulation with that code. + from warp.run_modes.timestepper import PICAPI from ._libwarpx import libwarpx |