diff options
Diffstat (limited to 'Docs/source/running_python')
| -rw-r--r-- | Docs/source/running_python/running_picmi.rst | 35 | ||||
| -rw-r--r-- | Docs/source/running_python/running_python.rst | 1 |
2 files changed, 36 insertions, 0 deletions
diff --git a/Docs/source/running_python/running_picmi.rst b/Docs/source/running_python/running_picmi.rst new file mode 100644 index 000000000..509122f2e --- /dev/null +++ b/Docs/source/running_python/running_picmi.rst @@ -0,0 +1,35 @@ +Running WarpX from PICMI +======================== + +See `PICMI information and source code <https://github.com/picmi-standard/picmi>`__. + +Generate WarpX input from PICMI python script +--------------------------------------------- + +You can **install** the PICMI standard via, for example: + +:: + + pip install picmistandard + +For other options, please visit link above. + +To install the WarpX implementation of PICMI go to the WarpX directory and do: + +:: + + cd Python + python setup.py install + +Then you can **run**, for example, the :download:`Example PICMI input script for laser-plasma acceleration <../../../Examples/Physics_applications/laser_acceleration/PICMI_inputs_laser_acceleration.py>` with + +:: + + python PICMI_inputs_laser_acceleration.py + +to create the WarpX input file that you can run with the WarpX executable. + +Running WarpX with python binding form PICMI +-------------------------------------------- + +This option is not (yet) supported. diff --git a/Docs/source/running_python/running_python.rst b/Docs/source/running_python/running_python.rst index cf960d431..fc065cedc 100644 --- a/Docs/source/running_python/running_python.rst +++ b/Docs/source/running_python/running_python.rst @@ -6,3 +6,4 @@ Running WarpX from Python how_to_run examples + running_picmi |