:orphan:

Example gallery of PySRW
========================

A collection of samples to show the main features of the PySRW module.

Explore these examples to become familiar with the main functionalities of PySRW. 
Comments will guide you through the simulations. 
If you'd like more information about a particular object, 
refer to the :ref:`API documentation <pysrw>`!

.. warning::
    These scripts can run on a mid-level machine (4GB RAM - 4 cores) in a  
    reasonable time, a few minutes at most. Changing simulation parameters 
    may result in significantly longer and resource-intensive simulations or could 
    even produce incorrect outputs. Use these scripts as a playground to become 
    familiar with the pros and cons of SRW.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Basic example of computation of the power density of the radiation emitted  by an electron beam...">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_power_density_thumb.png
    :alt:

  :ref:`sphx_glr_examples_power_density.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Synchrotron Radiation power density</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Example to familiarize with the coordinate system used by SRW.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_coordinates_thumb.png
    :alt:

  :ref:`sphx_glr_examples_coordinates.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Coordinates</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Basic example of computation of the field emitted by an isotropic point source.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_point_source_thumb.png
    :alt:

  :ref:`sphx_glr_examples_point_source.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Point source</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Basic example of computation of the field emitted by a coherent Gaussian beam.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_gaussian_beam_thumb.png
    :alt:

  :ref:`sphx_glr_examples_gaussian_beam.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Gaussian beam</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Example to show the simulation of a arbitrary magnetic field. A longitudinal  gradient dipole f...">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_custom_magnet_thumb.png
    :alt:

  :ref:`sphx_glr_examples_custom_magnet.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Custom magnet</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Example to demonstrate the flexibility of SRW propagation with the definition  of a custom tran...">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_transmission_element_thumb.png
    :alt:

  :ref:`sphx_glr_examples_transmission_element.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Transmission element</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Basic example of physical optics propagation through a simple optical system  consisting of a s...">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_simple_propagation_thumb.png
    :alt:

  :ref:`sphx_glr_examples_simple_propagation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Simple propagation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Basic example of computation of the field emitted by an undulator of a  synchrotron light sourc...">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_simple_undulator_thumb.png
    :alt:

  :ref:`sphx_glr_examples_simple_undulator.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Simple planar undulator</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Basic example of computation of synchrotron radiation spectrum.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_spectrum_thumb.png
    :alt:

  :ref:`sphx_glr_examples_spectrum.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Spectrum</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Evolution of the wavefront emitted by the LHC source during the energy ramp. This examples show...">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_lhc_source_thumb.gif
    :alt:

  :ref:`sphx_glr_examples_lhc_source.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">LHC source</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Basic example of computation of the field emitted by an electron beam  deflected by a simple di...">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_simple_dipole_thumb.png
    :alt:

  :ref:`sphx_glr_examples_simple_dipole.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Simple dipole magnet</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A double slit interferometer with a point source. Multiprocess propagation is  used to obtain t...">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_interferometer_thumb.png
    :alt:

  :ref:`sphx_glr_examples_interferometer.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Interferometer</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to combine two planar undulators to create a helical  undulator. The par...">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_helical_undulator_thumb.png
    :alt:

  :ref:`sphx_glr_examples_helical_undulator.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Helical undulator</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /examples/power_density
   /examples/coordinates
   /examples/point_source
   /examples/gaussian_beam
   /examples/custom_magnet
   /examples/transmission_element
   /examples/simple_propagation
   /examples/simple_undulator
   /examples/spectrum
   /examples/lhc_source
   /examples/simple_dipole
   /examples/interferometer
   /examples/helical_undulator


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: examples_python.zip </examples/examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: examples_jupyter.zip </examples/examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_