Accelerator, radiation and x-ray optics simulation framework

Ocelot

Ocelot is an open-source multiphysics simulation toolkit for accelerator physics. It is designed to model Free Electron Lasers (FELs), storage rings, and transport lines using a modular and scriptable Python interface.

• Website: https://www.ocelot-collab.com
• Documentation: https://www.ocelot-collab.com/docs/docu/intro
• Tutorials: https://www.ocelot-collab.com/docs/tutorial/intro
• Source code: https://github.com/ocelot-collab/ocelot
• Bug reports: https://github.com/ocelot-collab/ocelot/issues
• License: GPL-3.0 license

---

Features

Ocelot provides:

• A modular framework for beam dynamics simulations (tracking, optics, matching)
• Physics processes including:
  • Space charge
  • Coherent synchrotron radiation (CSR)
  • Wakefields
  • and many more
• A framework for FEL-related studies and synchrotron calculation
• Jupyter-based interactive tutorials for education and development

---

Getting Started

For requirements and installation instructions, see the official guide: 👉 Installation & Setup

To explore tutorials, visit: 👉 Tutorial Overview 👉 Student-Friendly Introduction

---

Core Modules & API Reference

Ocelot's core functionality is organized into key modules:

📘 Lattice Elements & Design

• Elements - Lattice element definitions (dipoles, quadrupoles, cavities, etc.)
  • OpticElement, Element, Magnet - Base classes with inheritance hierarchy
  • Drift, Bend, RBend, SBend, Quadrupole, Sextupole, Octupole
  • Cavity, TDCavity, Undulator, Marker, Monitor, Aperture

🔬 Beam Physics & Tracking

• Beam - Beam models and particle arrays
  • Beam, Twiss - Beam envelopes and Twiss parameters
  • ParticleArray, Particle - Individual particle tracking
  • generate_parray(), ellipse_from_twiss() - Beam generation utilities

🎯 Tracking & Optics

• Tracking - Particle and beam tracking algorithms
• Optics - Optics calculations and transfer maps
  • MagneticLattice - Core lattice object for simulations
  • Navigator - Lattice navigation utilities

⚡ Physics Processes

• Space Charge - Space charge effects
• CSR - Coherent synchrotron radiation
• Wake Fields - Longitudinal and transverse wake effects
• Physics Processes - Extensible framework for custom effects

🔧 Advanced Features

• Chromaticity Compensation
• Beam Matching - Automated optics matching
• Beam Parameter Calculations

---

We welcome feedback, contributions, and new ideas

• How to create a pull request
• How to add unit tests
• How to create your own Physics Process class

Disclaimer: The OCELOT code comes with absolutely NO warranty. The authors of the OCELOT do not take any responsibility for any damage to equipments or personnel injury that may result from the use of the code.