diff --git a/examples/cfbend/README.rst b/examples/cfbend/README.rst index 84c1ba6bc..75a99ac47 100644 --- a/examples/cfbend/README.rst +++ b/examples/cfbend/README.rst @@ -17,18 +17,22 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_cfbend.py``) or with an app with an input file (``impactx input_cfbend.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_cfbend.py`` or +* ImpactX **executable** using an input file: ``impactx input_cfbend.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: - .. tab-item:: Python Script + .. tab-item:: Python: Script .. literalinclude:: run_cfbend.py :language: python3 :caption: You can copy this file from ``examples/cfbend/run_cfbend.py``. - .. tab-item:: App Input File + .. tab-item:: Executable: Input File .. literalinclude:: input_cfbend.in :language: ini diff --git a/examples/cfchannel/README.rst b/examples/cfchannel/README.rst index d8ee501ce..aadc77a1b 100644 --- a/examples/cfchannel/README.rst +++ b/examples/cfchannel/README.rst @@ -25,8 +25,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_cfchannel.py``) or with an app with an input file (``impactx input_cfchannel.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_cfchannel.py`` or +* ImpactX **executable** using an input file: ``impactx input_cfchannel.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/chicane/README.rst b/examples/chicane/README.rst index b3b9306d0..7b8fa04cf 100644 --- a/examples/chicane/README.rst +++ b/examples/chicane/README.rst @@ -17,8 +17,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_chicane.py``) or with an app with an input file (``impactx input_chicane.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_chicane.py`` or +* ImpactX **executable** using an input file: ``impactx input_chicane.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/compression/README.rst b/examples/compression/README.rst index 207fcbe8c..e2ec18f87 100644 --- a/examples/compression/README.rst +++ b/examples/compression/README.rst @@ -16,8 +16,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_compression.py``) or with an app with an input file (``impactx input_compression.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_compression.py`` or +* ImpactX **executable** using an input file: ``impactx input_compression.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/cyclotron/README.rst b/examples/cyclotron/README.rst index 1094ca243..9dfd82b9f 100644 --- a/examples/cyclotron/README.rst +++ b/examples/cyclotron/README.rst @@ -10,8 +10,12 @@ This demonstrates a simple cyclotron as published by Ernest O. Lawrence and M. S Run --- -This example can be run as a Python script (``python3 run_cyclotron.py``) or with an app with an input file (``impactx input_cyclotron.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_cyclotron.py`` or +* ImpactX **executable** using an input file: ``impactx input_cyclotron.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/expanding_beam/README.rst b/examples/expanding_beam/README.rst index 7cc8caa16..0c95d487a 100644 --- a/examples/expanding_beam/README.rst +++ b/examples/expanding_beam/README.rst @@ -18,8 +18,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_expanding.py``) or with an app with an input file (``impactx input_expanding.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_expanding.py`` or +* ImpactX **executable** using an input file: ``impactx input_expanding.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/fodo/README.rst b/examples/fodo/README.rst index b9cfa6efa..f6efcb6a7 100644 --- a/examples/fodo/README.rst +++ b/examples/fodo/README.rst @@ -22,8 +22,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_fodo.py``) or with an app with an input file (``impactx input_fodo.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_fodo.py`` or +* ImpactX **executable** using an input file: ``impactx input_fodo.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/fodo_chromatic/README.rst b/examples/fodo_chromatic/README.rst index 87eef4cdb..2da9b0f00 100644 --- a/examples/fodo_chromatic/README.rst +++ b/examples/fodo_chromatic/README.rst @@ -23,8 +23,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_fodo_chr.py``) or with an app with an input file (``impactx input_fodo_chr.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_fodo_chr.py`` or +* ImpactX **executable** using an input file: ``impactx input_fodo_chr.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/fodo_rf/README.rst b/examples/fodo_rf/README.rst index c0ae7f63e..dd04fb53f 100644 --- a/examples/fodo_rf/README.rst +++ b/examples/fodo_rf/README.rst @@ -27,8 +27,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_fodo_rf.py``) or with an app with an input file (``impactx input_fodo_rf.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_fodo_rf.py`` or +* ImpactX **executable** using an input file: ``impactx input_fodo_rf.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/iota_lattice/README.rst b/examples/iota_lattice/README.rst index 9795bd420..07060bb58 100644 --- a/examples/iota_lattice/README.rst +++ b/examples/iota_lattice/README.rst @@ -16,8 +16,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_iotalattice.py``) or with an app with an input file (``impactx input_iotalattice.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_iotalattice.py`` or +* ImpactX **executable** using an input file: ``impactx input_iotalattice.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/iota_lens/README.rst b/examples/iota_lens/README.rst index 9cf3e4d01..b3acf3ac0 100644 --- a/examples/iota_lens/README.rst +++ b/examples/iota_lens/README.rst @@ -16,8 +16,12 @@ In this test, the initial and final values of :math:`\mu_H`, :math:`\sigma_H`, : Run --- -This example can be run as a Python script (``python3 run_iotalens.py``) or with an app with an input file (``impactx input_iotalens.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_iotalens.py`` or +* ImpactX **executable** using an input file: ``impactx input_iotalens.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/kicker/README.rst b/examples/kicker/README.rst index be43fd2dd..9921824ed 100644 --- a/examples/kicker/README.rst +++ b/examples/kicker/README.rst @@ -15,8 +15,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_kicker.py``) or with an app with an input file (``impactx input_kicker.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_kicker.py`` or +* ImpactX **executable** using an input file: ``impactx input_kicker.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/kurth/README.rst b/examples/kurth/README.rst index 7632da43d..c408fd1a7 100644 --- a/examples/kurth/README.rst +++ b/examples/kurth/README.rst @@ -20,8 +20,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_kurth_periodic.py``) or with an app with an input file (``impactx input_kurth_periodic.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_kurth_periodic.py`` or +* ImpactX **executable** using an input file: ``impactx input_kurth_periodic.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/multipole/README.rst b/examples/multipole/README.rst index 2725cf6d7..0ab2e5328 100644 --- a/examples/multipole/README.rst +++ b/examples/multipole/README.rst @@ -15,8 +15,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_multipole.py``) or with an app with an input file (``impactx input_multipole.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_multipole.py`` or +* ImpactX **executable** using an input file: ``impactx input_multipole.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/positron_channel/README.rst b/examples/positron_channel/README.rst index 9f58b6f16..eabc9c98e 100644 --- a/examples/positron_channel/README.rst +++ b/examples/positron_channel/README.rst @@ -19,8 +19,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_positron.py``) or with an app with an input file (``impactx input_positron.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_positron.py`` or +* ImpactX **executable** using an input file: ``impactx input_positron.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/quadrupole_softedge/README.rst b/examples/quadrupole_softedge/README.rst index 41cc58452..22a3df548 100644 --- a/examples/quadrupole_softedge/README.rst +++ b/examples/quadrupole_softedge/README.rst @@ -16,8 +16,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_quadrupole_softedge.py``) or with an app with an input file (``impactx input_quadrupole_softedge.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_quadrupole_softedge.py`` or +* ImpactX **executable** using an input file: ``impactx input_quadrupole_softedge.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/rfcavity/README.rst b/examples/rfcavity/README.rst index 8154476c5..f63109148 100644 --- a/examples/rfcavity/README.rst +++ b/examples/rfcavity/README.rst @@ -20,8 +20,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_rfcavity.py``) or with an app with an input file (``impactx input_rfcavity.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_rfcavity.py`` or +* ImpactX **executable** using an input file: ``impactx input_rfcavity.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/rotation/README.rst b/examples/rotation/README.rst index bd09518d6..083112533 100644 --- a/examples/rotation/README.rst +++ b/examples/rotation/README.rst @@ -16,8 +16,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_rotation.py``) or with an app with an input file (``impactx input_rotation.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_rotation.py`` or +* ImpactX **executable** using an input file: ``impactx input_rotation.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/solenoid/README.rst b/examples/solenoid/README.rst index dcb6ff0fa..f733b8568 100644 --- a/examples/solenoid/README.rst +++ b/examples/solenoid/README.rst @@ -26,8 +26,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_solenoid.py``) or with an app with an input file (``impactx input_solenoid.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_solenoid.py`` or +* ImpactX **executable** using an input file: ``impactx input_solenoid.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set:: diff --git a/examples/solenoid_softedge/README.rst b/examples/solenoid_softedge/README.rst index f4332ad15..9576a3f76 100644 --- a/examples/solenoid_softedge/README.rst +++ b/examples/solenoid_softedge/README.rst @@ -24,8 +24,12 @@ In this test, the initial and final values of :math:`\sigma_x`, :math:`\sigma_y` Run --- -This example can be run as a Python script (``python3 run_solenoid_softedge.py``) or with an app with an input file (``impactx input_solenoid_softedge.in``). -Each can also be prefixed with an `MPI executor `__, such as ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. +This example can be run **either** as: + +* **Python** script: ``python3 run_solenoid_softedge.py`` or +* ImpactX **executable** using an input file: ``impactx input_solenoid_softedge.in`` + +For `MPI-parallel `__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system. .. tab-set::