Skip to content

Commit

Permalink
Doc: Examples w/ New Run Intro (#459)
Browse files Browse the repository at this point in the history
Improve wording in each example's `Run` section.
  • Loading branch information
ax3l authored Nov 7, 2023
1 parent 5ae85fa commit e758793
Show file tree
Hide file tree
Showing 20 changed files with 122 additions and 42 deletions.
12 changes: 8 additions & 4 deletions examples/cfbend/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ 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
Expand Down
8 changes: 6 additions & 2 deletions examples/cfchannel/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/chicane/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/compression/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/cyclotron/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/expanding_beam/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/fodo/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/fodo_chromatic/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/fodo_rf/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/iota_lattice/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/iota_lens/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/kicker/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/kurth/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/multipole/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/positron_channel/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/quadrupole_softedge/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/rfcavity/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/rotation/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/solenoid/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down
8 changes: 6 additions & 2 deletions examples/solenoid_softedge/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.mpi-forum.org>`__, 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 <https://www.mpi-forum.org>`__ runs, prefix these lines with ``mpiexec -n 4 ...`` or ``srun -n 4 ...``, depending on the system.

.. tab-set::

Expand Down

0 comments on commit e758793

Please sign in to comment.