beam_calculator section (mandatory)

Entry	Type	Description	Allowed values	Mandatory?
tool	str	Name of the tool	tools	✅

If the desired BeamCalculator is Envelope1D:

Entry	Type	Description	Allowed values	Mandatory?
flag_phi_abs	bool	Simulation realized in absolute phase?		✅
flag_cython	bool	Use Cython implementation?		✅
n_steps_per_cell	int	# of integration steps per cavity cell		✅
method	str	Integration method	methods	✅

Note that Envelope3D takes the same configuration entries, except flag_cython (not implemented yet) and method that must be 'RK4' ('leapgrog' not implemented yet).

If the desired BeamCalculator is TraceWin:

Entry	Type	Description	Allowed values	Mandatory?
machine_config_file	str	A .toml file with paths to the executables	existing relative (w.r.t lightwin.toml) or absolute paths	✅
machine_name	str	Name of machine	must be a key in the machine_config_file	❌
simulation_type	str	TraceWin solver	Must be an entry under your machine name in machine_config_file	✅
ini_path	path	Path to TraceWin’s .ini file		✅
hide	bool	To avoid TraceWin window	None	❌
partran	int	To force or not Partran tracking	1 or 0	❌
…		Every TraceWin command line option		❌

Check TraceWin’s documentation for the list of command line arguments. Note that you also need to create a configuration file that will define the path to the TraceWin executables. See data/examples/machine_config_file.toml for an example.

Todo

List of allowed tracewin arguments in doc

Todo

There are doublons between doc in config.beam_calculator and here. Maybe keep in module, but make the format better.

The [beam_calculator_post] follows the same format. It is used to store a second BeamCalculator. This is mainly useful for defining a more precise – but more time-consuming – beam dynamics tool, for example to check your compensation settings.