Configuration

• files section (mandatory)
• beam section (mandatory)
• beam_calculator section (mandatory)
  • Envelope1D solver
  • Envelope3D solver
  • TraceWin solver
• plots section (mandatory)
• wtf section
  • Common configuration keys
    • Choice of failed cavities
      • General case
      • Automatic studies
      • Manual association of failed/compensating cavities
    • Attribution of compensating cavities to every fault
  • k out of n method
  • l neighboring lattices method
  • Corrector at exit method
  • Manual association of failed / compensating cavities
  • Global, global downstream compensation
  • Settings optimization problem
    • Optimisation objectives
    • Optimisation algorithms
• design_space section
  • Under implementation
• evaluators section

Most of the configuration of LightWin is performed through a TOML configuration file, which should be given as argument to several objects initialisation. The configuration file is treated with the help of the tomllib module. It is processed by the config.config_manager.process_config() function, which checks its validity and converts it to a dictionary.

The name of every section is not important, as long as every section is correctly passed to config.config_manager.process_config(). It is however recommended to use explicit names.

Example for the beam section

[beam_proton]     # this could be [bonjoure] or anything
e_rest_mev = 938.27203
q_adim = 1.0
e_mev = 20.0
f_bunch_mhz = 350.0
i_milli_a = 25.
sigma = [
   [ 1e-6, -2e-7, 0.0,   0.0,  0.0,   0.0],
   [-2e-7,  8e-7, 0.0,   0.0,  0.0,   0.0],
   [ 0.0,   0.0,  1e-6, -2e-7, 0.0,   0.0],
   [ 0.0,   0.0, -2e-7,  8e-7, 0.0,   0.0],
   [ 0.0,   0.0,  0.0,   0.0,  1e-6, -2e-7],
   [ 0.0,   0.0,  0.0,   0.0, -2e-7,  8e-7],
]

[beam_proton_no_space_charge]   # or [sdaflghsh] but it would be less explicit in my humble opinion
e_rest_mev = 938.27203
q_adim = 1.0
e_mev = 20.0
f_bunch_mhz = 350.0
i_milli_a = 0.0
sigma = [
   [ 1e-6, -2e-7, 0.0,   0.0,  0.0,   0.0],
   [-2e-7,  8e-7, 0.0,   0.0,  0.0,   0.0],
   [ 0.0,   0.0,  1e-6, -2e-7, 0.0,   0.0],
   [ 0.0,   0.0, -2e-7,  8e-7, 0.0,   0.0],
   [ 0.0,   0.0,  0.0,   0.0,  1e-6, -2e-7],
   [ 0.0,   0.0,  0.0,   0.0, -2e-7,  8e-7],
]

Note

In order to dynamically keep track of the options that are implemented, the Allowed values column of following tables contains a link to the variable storing the possible values, when relevant.