OCELOT Documentation


OCELOT is a framework for synchrotron light source and FEL design and operation.

Ocelot is a multiphysics simulation toolkit designed for studying FEL and storage ring based light sources. Ocelot is written in Python. Its central concept is the writing of Python’s scripts for simulations with the usage of Ocelot’s modules and functions and the standard Python libraries.

Ocelot includes following main modules:

  • Charged particle beam dynamics module (CPBD)
    • optics

    • tracking

    • matching

    • collective effects
      • Space Charge (true 3D Laplace solver)

      • CSR (Coherent Synchrotron Radiation) (1D model with arbitrary number of dipoles) (under development).

      • Wakefields (Taylor expansion up to second order for arbitrary geometry).

    • MOGA (Multi Objective Genetics Algorithm). (under development but we have already applied it for a storage ring application

  • Native module for spontaneous radiation calculation

  • FEL calculations: interface to GENESIS and pre/post-processing

  • Modules for online beam control and online optimization of accelerator performances. Work1 , work2 , work3 .

Ocelot extensively uses Python’s NumPy (Numerical Python and SciPy (Scientific Python) libraries, which enable efficient in-core numerical and scientific computation within Python and give you access to various mathematical and optimization techniques and algorithms. To produce high quality figures Python’s matplotlib library is used.

It is an open source project and it is being developed by physicists from The European XFEL , DESY (Germany), NRC Kurchatov Institute (Russia).

  • Ocelot user profile

Ocelot is designed for researchers who want to have the flexibility that is given by high-level languages such as Matlab, Python (with Numpy and SciPy) or Mathematica. However if someone needs a GUI it can be developed using Python’s libraries like a PyQtGraph or PyQt .


You can install it via pip in your terminal

python -m pip install git+https://github.com/ocelot-collab/ocelot.git@v19.12.0

Where you might have to update the version (here v19.12.0) to the release you want to install.

Alternatively, you can download the zip file from GitHub.

Unzip ocelot-master.zip to your working folder ../your_working_dir/.

Rename folder ../your_working_dir/ocelot-master to ../your_working_dir/ocelot. Add ../your_working_dir/ to PYTHONPATH

Windows 7: go to Control Panel -> System and Security -> System -> Advance System Settings -> Environment Variables. and in User variables add ../your_working_dir/ to PYTHONPATH. If variable PYTHONPATH does not exist, create it.

Variable name: PYTHONPATH

Variable value: ../your_working_dir/


$ export PYTHONPATH=**../your_working_dir/**:$PYTHONPATH

Indices and tables