From c8b0aa8cda2be070831f50e93ec4837a0e8e6cec Mon Sep 17 00:00:00 2001 From: David Grote Date: Tue, 21 Apr 2020 16:35:23 -0700 Subject: Python documentation updates (#936) * Update Python documentation * Added numpy as a requirement for the Python installation * Cleaned EOL white space in Python documentation * Add periodictable to the Python packages required Co-Authored-By: Axel Huebl * Added periodictable to required packages for pure Python version Co-authored-by: Axel Huebl --- Docs/source/running_python/examples.rst | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) (limited to 'Docs/source/running_python/examples.rst') diff --git a/Docs/source/running_python/examples.rst b/Docs/source/running_python/examples.rst index 851d2e52f..4104bcf78 100644 --- a/Docs/source/running_python/examples.rst +++ b/Docs/source/running_python/examples.rst @@ -1,16 +1,27 @@ Example input files =================== -This section allows you to **download Python scripts** that correspond to different -physical situations. +WarpX includes several example Python input files corresponding to various physical situations. +These can be downloaded here (or obtained from the WarpX source). Beam-driven acceleration ------------------------ -* :download:`Without mesh refinement<../../../Examples/Physics_applications/plasma_acceleration/plasma_acceleration_PICMI.py>` -* :download:`With mesh refinement<../../../Examples/Physics_applications/plasma_acceleration/plasma_acceleration_PICMI.mr.py>` +* :download:`Without mesh refinement<../../../Examples/Physics_applications/plasma_acceleration/PICMI_inputs_plasma_acceleration.py>` +* :download:`With mesh refinement<../../../Examples/Physics_applications/plasma_acceleration/PICMI_inputs_plasma_acceleration_mr.py>` Laser-driven acceleration ------------------------- -* :download:`Without mesh refinement<../../../Examples/Physics_applications/laser_acceleration/laser_acceleration_PICMI.py>` +* :download:`Without mesh refinement<../../../Examples/Physics_applications/laser_acceleration/PICMI_inputs_laser_acceleration.py>` + +Test cases +---------- + +There are also several test cases included that can be used for reference. + +* :download:`Gaussian beam<../../../Examples//Modules/gaussian_beam/PICMI_inputs_gaussian_beam.py>` +* :download:`Langmuir plasma wave test in 3d<../../../Examples//Tests/Langmuir/PICMI_inputs_langmuir_rt.py>` +* :download:`Langmuir plasma wave test in RZ<../../../Examples//Tests/Langmuir/PICMI_inputs_langmuir_rz_multimode_analyze.py>` +* :download:`Langmuir plasma wave test in 2D<../../../Examples//Tests/Langmuir/PICMI_inputs_langmuir2d.py>` + -- cgit v1.2.3