diff --git a/Docs/source/developers/particles.rst b/Docs/source/developers/particles.rst index 53a0090b5c9..37260d1ed64 100644 --- a/Docs/source/developers/particles.rst +++ b/Docs/source/developers/particles.rst @@ -160,7 +160,7 @@ Attribute name ``int``/``real`` Description Default when they were created. ================== ================ ================================= ============== -A Python example that adds runtime options can be found in :download:`Examples/Tests/particle_data_python <../../../Examples/Tests/particle_data_python/PICMI_inputs_prev_pos_2d.py>` +A Python example that adds runtime options can be found in :download:`Examples/Tests/particle_data_python <../../../Examples/Tests/particle_data_python/inputs_test_2d_prev_positions_picmi.py>` .. note:: diff --git a/Docs/source/usage/examples.rst b/Docs/source/usage/examples.rst index 0492372b4e6..244fbda6f75 100644 --- a/Docs/source/usage/examples.rst +++ b/Docs/source/usage/examples.rst @@ -43,7 +43,7 @@ Particle Accelerator & Beam Physics :maxdepth: 1 examples/gaussian_beam/README.rst - examples/beam-beam_collision/README.rst + examples/beam_beam_collision/README.rst High Energy Astrophysical Plasma Physics @@ -101,7 +101,7 @@ examples below were generated at that time. .. toctree:: :maxdepth: 1 - examples/ohm_solver_EM_modes/README.rst + examples/ohm_solver_em_modes/README.rst examples/ohm_solver_ion_beam_instability/README.rst examples/ohm_solver_ion_Landau_damping/README.rst @@ -127,11 +127,11 @@ Manipulating fields via Python An example of using Python to access the simulation charge density, solve the Poisson equation (using ``superLU``) and write the resulting electrostatic potential back to the simulation is given in the input file below. This example uses the ``fields.py`` module included in the ``pywarpx`` library. -* :download:`Direct Poisson solver example <../../../Examples/Physics_applications/capacitive_discharge/PICMI_inputs_2d.py>` +* :download:`Direct Poisson solver example <../../../Examples/Physics_applications/capacitive_discharge/inputs_test_2d_background_mcc_picmi.py>` An example of initializing the fields by accessing their data through Python, advancing the simulation for a chosen number of time steps, and plotting the fields again through Python. The simulation runs with 128 regular cells, 8 guard cells, and 10 PML cells, in each direction. Moreover, it uses div(E) and div(B) cleaning both in the regular grid and in the PML and initializes all available electromagnetic fields (E,B,F,G) identically. -* :download:`Unit pulse with PML <../../../Examples/Tests/python_wrappers/PICMI_inputs_2d.py>` +* :download:`Unit pulse with PML <../../../Examples/Tests/python_wrappers/inputs_test_2d_python_wrappers_picmi.py>` Many Further Examples, Demos and Tests diff --git a/Docs/source/usage/examples/beam-beam_collision b/Docs/source/usage/examples/beam-beam_collision deleted file mode 120000 index 8c6ac6b30b1..00000000000 --- a/Docs/source/usage/examples/beam-beam_collision +++ /dev/null @@ -1 +0,0 @@ -../../../../Examples/Physics_applications/beam-beam_collision \ No newline at end of file diff --git a/Docs/source/usage/examples/beam_beam_collision b/Docs/source/usage/examples/beam_beam_collision new file mode 120000 index 00000000000..2f46224fd8b --- /dev/null +++ b/Docs/source/usage/examples/beam_beam_collision @@ -0,0 +1 @@ +../../../../Examples/Physics_applications/beam_beam_collision/ \ No newline at end of file diff --git a/Docs/source/usage/examples/ohm_solver_EM_modes b/Docs/source/usage/examples/ohm_solver_EM_modes deleted file mode 120000 index 485be7241ae..00000000000 --- a/Docs/source/usage/examples/ohm_solver_EM_modes +++ /dev/null @@ -1 +0,0 @@ -../../../../Examples/Tests/ohm_solver_EM_modes \ No newline at end of file diff --git a/Docs/source/usage/examples/ohm_solver_em_modes b/Docs/source/usage/examples/ohm_solver_em_modes new file mode 120000 index 00000000000..03214170a1f --- /dev/null +++ b/Docs/source/usage/examples/ohm_solver_em_modes @@ -0,0 +1 @@ +../../../../Examples/Tests/ohm_solver_em_modes/ \ No newline at end of file diff --git a/Docs/source/usage/pwfa.rst b/Docs/source/usage/pwfa.rst index 5119184089c..1d3481b5589 100644 --- a/Docs/source/usage/pwfa.rst +++ b/Docs/source/usage/pwfa.rst @@ -5,7 +5,7 @@ In-Depth: PWFA As described in the :doc:`../theory/intro`, one of the key applications of the WarpX exascale computing platform is in modelling future, compact and economic plasma-based accelerators. In this section we describe the simulation setup of a realistic *electron beam driven plasma wakefield accelerator* (PWFA) configuration. -For illustration purposes the setup can be explored with **WarpX** using the example input file :download:`PWFA <../../../Examples/Physics_applications/plasma_acceleration/inputs_2d_boost>`. +For illustration purposes the setup can be explored with **WarpX** using the example input file :download:`PWFA <../../../Examples/Physics_applications/plasma_acceleration/inputs_test_2d_plasma_acceleration_boosted>`. The simulation setup consists of 4 particle species: drive beam (driver), witness beam (beam), plasma electrons (plasma_e), and plasma ions (plasma_p). The species physical parameters are summarized in the following table. diff --git a/Examples/Physics_applications/beam_beam_collision/README b/Examples/Physics_applications/beam_beam_collision/README.rst similarity index 100% rename from Examples/Physics_applications/beam_beam_collision/README rename to Examples/Physics_applications/beam_beam_collision/README.rst diff --git a/Examples/Physics_applications/capacitive_discharge/README b/Examples/Physics_applications/capacitive_discharge/README.rst similarity index 91% rename from Examples/Physics_applications/capacitive_discharge/README rename to Examples/Physics_applications/capacitive_discharge/README.rst index 708b4528cd5..13b6b3010b3 100644 --- a/Examples/Physics_applications/capacitive_discharge/README +++ b/Examples/Physics_applications/capacitive_discharge/README.rst @@ -22,17 +22,17 @@ The implementation has been tested against the benchmark results from :cite:t:`e Run --- -The 1D PICMI input file can be used to reproduce the results from Turner et al. for a given case, ``N`` from 1 to 4, by executing ``python3 PICMI_inputs_1d.py -n N``, e.g., +The 1D PICMI input file can be used to reproduce the results from Turner et al. for a given case, ``N`` from 1 to 4, by executing ``python3 inputs_base_1d_picmi.py -n N``, e.g., .. code-block:: bash - python3 PICMI_inputs_1d.py -n 1 + python3 inputs_base_1d_picmi.py -n 1 For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. -.. literalinclude:: PICMI_inputs_1d.py +.. literalinclude:: inputs_base_1d_picmi.py :language: python3 - :caption: You can copy this file from ``Examples/Physics_applications/capacitive_discharge/PICMI_inputs_1d.py``. + :caption: You can copy this file from ``Examples/Physics_applications/capacitive_discharge/inputs_base_1d_picmi.py``. Analyze diff --git a/Examples/Physics_applications/capacitive_discharge/analysis_2d.py b/Examples/Physics_applications/capacitive_discharge/analysis_2d.py index e9782fabe23..f52f69f4bf4 100755 --- a/Examples/Physics_applications/capacitive_discharge/analysis_2d.py +++ b/Examples/Physics_applications/capacitive_discharge/analysis_2d.py @@ -2,7 +2,7 @@ # Copyright 2021 Modern Electron -# This script checks that the PICMI_inputs_2d.py run more-or-less matches the +# This script checks that the inputs_test_2d_background_mcc_picmi.py run more-or-less matches the # results from the non-PICMI run. The PICMI run is using an external Poisson # solver that directly solves the Poisson equation using matrix inversion # rather than the iterative approach from the MLMG solver. diff --git a/Examples/Physics_applications/laser_acceleration/README b/Examples/Physics_applications/laser_acceleration/README.rst similarity index 100% rename from Examples/Physics_applications/laser_acceleration/README rename to Examples/Physics_applications/laser_acceleration/README.rst diff --git a/Examples/Physics_applications/laser_ion/README b/Examples/Physics_applications/laser_ion/README.rst similarity index 100% rename from Examples/Physics_applications/laser_ion/README rename to Examples/Physics_applications/laser_ion/README.rst diff --git a/Examples/Physics_applications/plasma_acceleration/README b/Examples/Physics_applications/plasma_acceleration/README.rst similarity index 100% rename from Examples/Physics_applications/plasma_acceleration/README rename to Examples/Physics_applications/plasma_acceleration/README.rst diff --git a/Examples/Physics_applications/plasma_mirror/README b/Examples/Physics_applications/plasma_mirror/README.rst similarity index 100% rename from Examples/Physics_applications/plasma_mirror/README rename to Examples/Physics_applications/plasma_mirror/README.rst diff --git a/Examples/Physics_applications/uniform_plasma/README b/Examples/Physics_applications/uniform_plasma/README.rst similarity index 100% rename from Examples/Physics_applications/uniform_plasma/README rename to Examples/Physics_applications/uniform_plasma/README.rst diff --git a/Examples/Tests/gaussian_beam/README b/Examples/Tests/gaussian_beam/README.rst similarity index 100% rename from Examples/Tests/gaussian_beam/README rename to Examples/Tests/gaussian_beam/README.rst diff --git a/Examples/Tests/langmuir/README b/Examples/Tests/langmuir/README.rst similarity index 100% rename from Examples/Tests/langmuir/README rename to Examples/Tests/langmuir/README.rst diff --git a/Examples/Tests/ohm_solver_em_modes/README b/Examples/Tests/ohm_solver_em_modes/README.rst similarity index 100% rename from Examples/Tests/ohm_solver_em_modes/README rename to Examples/Tests/ohm_solver_em_modes/README.rst diff --git a/Examples/Tests/ohm_solver_ion_Landau_damping/README b/Examples/Tests/ohm_solver_ion_Landau_damping/README.rst similarity index 100% rename from Examples/Tests/ohm_solver_ion_Landau_damping/README rename to Examples/Tests/ohm_solver_ion_Landau_damping/README.rst diff --git a/Examples/Tests/ohm_solver_ion_beam_instability/README b/Examples/Tests/ohm_solver_ion_beam_instability/README.rst similarity index 100% rename from Examples/Tests/ohm_solver_ion_beam_instability/README rename to Examples/Tests/ohm_solver_ion_beam_instability/README.rst diff --git a/Examples/Tests/ohm_solver_magnetic_reconnection/README b/Examples/Tests/ohm_solver_magnetic_reconnection/README.rst similarity index 80% rename from Examples/Tests/ohm_solver_magnetic_reconnection/README rename to Examples/Tests/ohm_solver_magnetic_reconnection/README.rst index 943b5bd0248..5181a6381d8 100644 --- a/Examples/Tests/ohm_solver_magnetic_reconnection/README +++ b/Examples/Tests/ohm_solver_magnetic_reconnection/README.rst @@ -12,11 +12,11 @@ Run The following **Python** script configures and launches the simulation. -.. dropdown:: Script ``PICMI_inputs.py`` +.. dropdown:: Script ``inputs_test_2d_ohm_solver_magnetic_reconnection_picmi.py`` - .. literalinclude:: PICMI_inputs.py + .. literalinclude:: inputs_test_2d_ohm_solver_magnetic_reconnection_picmi.py :language: python3 - :caption: You can copy this file from ``Examples/Tests/ohm_solver_magnetic_reconnection/PICMI_inputs.py``. + :caption: You can copy this file from ``Examples/Tests/ohm_solver_magnetic_reconnection/inputs_test_2d_ohm_solver_magnetic_reconnection_picmi.py``. Running the full simulation should take about 4 hours if executed on 1 V100 GPU. For `MPI-parallel `__ runs, prefix these lines with @@ -24,7 +24,7 @@ For `MPI-parallel `__ runs, prefix these lines with .. code-block:: bash - python3 PICMI_inputs.py + python3 inputs_test_2d_ohm_solver_magnetic_reconnection_picmi.py Analyze -------