Zgoubidoo’s documentation

Zgoubidoo: a modern Python 3 interface to particle tracking codes: Zgoubi and MAD-X.

Zgoubidoo is a Python 3 interface for Zgoubi, a ray-tracing code for beam dynamics simulations. Zgoubido is intended to follow a modern Python design and aims at being easy to use. Interactive use with iPython or Jupyter Notebook is supported and encouraged. As such Zgoubidoo can be viewed as a ‘Zgoubi for the mere mortal’ interface.

More recently, Zgoubidoo learned how to drive MAD-X, in a similar fashion as it runs Zgoubi (via the georges-core library). This is intended to promote more systematic comparisons between the codes (in the few corner cases where it is possible) and to allow the user to built a complete workflow with a single unified libary: indeed, the optical design of new machines typically starts with MAD-X for which Zgoubidoo provides a complete interface (survey, Twiss and tracking modules, as well as the equivalent PTC modules).

Zgoubi

Zgoubi is a ray-tracing (tracking) code for beam dynamics simulations. Many magnetic and electric elements are supported, as well as multiple other features, such as spin tracking. It is maintained by François Méot on SourceForge (Zgoubi SourceForge repository).

MAD-X and PTC

Design goals

• Fully featured interface to Zgoubi: all functionalities of Zgoubi are supported through the Python interface;

• Fully featuted interface to MAD-X and PTC: all functionalities are supported through the Python interface;

• Ease of use: a simple tracking study and its visualization can be set up in just a few lines of code;

• Written in high-quality Python 3 with type-hints;

• Built-in support for multi-core machines: it is possible and easy to run multiple simulations in parallel and to collect the final results;

• The library interface and use-n-feel is Jupyter notebook friendly;

• Decoupling between low-level and high-level use cases: the low-level support provides a simple Python interface to generate Zgoubi (or MAD-X) input files and run the executable while the high-level support provides interfaces with more abstraction (sequences, etc.);

• Strong support and enforcement of the systematic use of physical units: no units conversion nightmare, you can freely use whatever units set you like, the conversion into Zgoubi’s or MAD-X’s default units is automatically handled.

Publications

• Coming soon.

Contents:

• News and announcements
  • Release of Zgoubidoo 2019.3
  • Release of Zgoubidoo 2019.2
  • Release of Zgoubidoo 2019.1
• Installation
  • Compiling and installing Zgoubi
  • Obtaining Zgoubidoo
  • Creating a Python 3.7 environment with Conda
  • Installation Zgoubidoo using pip
  • Using Zgoubidoo with Jupyter Notebook
• Getting started
  • A simple FODO cell
• Zgoubi
  • Running Zgoubi with Zgoubidoo
• Zgoubi commands
  • Zgoubidoo’s class hierarchy and bases classes for new commands
  • Control-flow, calculation and miscellanous commands
  • Particule definition commands
  • Objet (bunch) definition commands
  • Monte-Carlo Objet (bunch) definition commands
  • Magnetic elements
  • Electric elements
  • Field-map elements
  • Spin tracking commands
  • Synchrotron radiation commands
• Zgoubidoo specialized and contributed commands
  • IBA elements
  • CERN elements
  • Emma elements
• Working with Zgoubi Input
• Using the Zgoubidoo low-level interface
  • Reading Zgoubi output files
  • Computing Twiss parameters
• Field maps
  • Functions
  • Classes
  • Class Inheritance Diagram
• Physics with Zgoubidoo high-level interfaces
  • Sequences
  • Beams
• Zgoubidoo’s visualization and plotting module
  • Classes
  • Class Inheritance Diagram
• Zgoubidoo’s utility modules
  • Affine geometry using the frame module
  • Accelerator physics and relativity calculations using the physics module
  • Units
  • Polarity type system
• Examples

Indices and tables

• Index

• Module Index

• Search Page