:mod:`ocelot.utils`
===================

.. py:module:: ocelot.utils


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   acc_utils/index.rst
   add_wake/index.rst
   create_db/index.rst
   db/index.rst
   launcher/index.rst
   mpi_utils/index.rst
   section_track/index.rst
   sim_gui/index.rst
   sim_info/index.rst
   sim_plot/index.rst
   wake_pws/index.rst
   xfel_utils/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   ocelot.utils.chicane_RTU


.. function:: chicane_RTU(yoke_len, dip_dist, r, type)

   Method calculate R56, T566, U5666 and path length of the reference particle for chicanes 's' and 'c' type

   :param yoke_len: dipole yoke length
   :param dip_dist: distance between 1st and 2nd dipoles on Z-axis (not a particle path but projection on Z-axis)
   :param r: radii of the dipoles
   :param type: type of the chicane "s" or "c"
   :return: R56, T566, U5666, Sref (distance between magnet 2 and 3 is 0)