From 13bb45254d82cd6c945846f2d18b2fcbbc2ad008 Mon Sep 17 00:00:00 2001 From: David Grote Date: Mon, 12 Jul 2021 09:08:16 -0700 Subject: Update Python module comments (#2073) * Added explanatory comments in timestepper.py * Add comments to WarpInterface.py * Added comments to WarpXPIC.py --- Python/pywarpx/WarpXPIC.py | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'Python/pywarpx/WarpXPIC.py') 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 -- cgit v1.2.3