Welcome to madgui’s documentation!

madgui is a Qt5 graphical user interface (GUI) written in Python, designed as an interactive frontend for MAD-X. Given a MAD-X input file, madgui is capable of showing the simulated lattice in an interactive window. Up until now it offers a very comfortable graphical representation of relevant quantities (e.g. beam envelope, alpha and beta optical functions, emittance, etc.), which aid to the control of the optimal parameters for the studied machine or lattice.

The following shows a plot for the Touschek example in the madx-examples repository, where the Touschek lifetimes and scattering rates are computed for LHC at injection. The beam envelope [mm] is shown for the first 300m of the lattice.

Contents

• Installation
• Getting started
  • Example 1: Sample beam line
  • Other examples
• User’s guide
  • Main window
  • Model
  • View
  • Export / Import
  • Settings
  • Online Control
  • Help
  • Setting up the model
• Developer’s guide
  • Development setup for madgui
  • Proxy Settings
  • Coding conventions
  • Related projects
  • Infrastructure
  • Creating a new version
• madgui package
  • Subpackages

Links

• Source code

• Issue tracker

• Latest release

• MAD-X source

Indices and tables

• Index

• Module Index

• Search Page