Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.17 KB

README.rst

File metadata and controls

59 lines (36 loc) · 1.17 KB
Raw

madgui

madgui is a Qt5 python GUI for interactive accelerator simulations using MAD-X via cpymad. It currently runs on python 3.4 and above, but higher python versions may be required in the near future.

Installation

pip install madgui

Usage

Now, you should be able to start madgui with the command:

madgui

Optionally, madgui can take a filename for a madx/model file:

madgui /path/to/model.madx

Note that madgui is currently only suited for relatively small sequences, on the scale of few hundred elements at the most.

Configuration

The application loads a YAML config file madgui.yml in the current directory or the user's home directory.

Example file:

model_path: ../hit_models
session_file: madgui.session.yml
online_control:
  connect: true
  backend: 'hit_acs.plugin:TestACS'
onload: |
  code to execute on startup

Development guidelines

See Developer's Guide.