.. _examples-gaussian-beam:

Gaussian Beam
=============

This example initializes a Gaussian beam distribution.


Run
---

This example can be run **either** as:

* **Python** script: ``python3 inputs_test_3d_gaussian_beam_picmi.py`` or
* WarpX **executable** using an input file: (*TODO*)

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

      .. literalinclude:: inputs_test_3d_gaussian_beam_picmi.py
         :language: python3
         :caption: You can copy this file from ``Examples/Tests/gaussian_beam/inputs_test_3d_gaussian_beam_picmi.py``.

   .. tab-item:: Executable: Input File

      .. note::

         TODO: This input file should be created following the ``inputs_test_3d_gaussian_beam_picmi.py`` file.


Analyze
-------

.. note::

   This section is TODO.


Visualize
---------

.. note::

   This section is TODO.