specs module

Define how TraceWin should be configured.

Todo

Handle args such as hide.

Note

In this module we also define MONKEY_PATCHES. They are used to modify the _pre_treat, validate and _post_treat methods from TableConfSpec.

TRACEWIN_CONFIG = ( KeyValConfSpec(key='export_phase', types=(<class 'str'>,), description='The type of phases that should be exported in ' 'the final `DAT` file. Note that ' "`'as_in_original_dat'` is not implemented yet, " "but `'as_in_settings'` should behave the same " 'way, provided that you alter no ' 'FieldMap.CavitySettings.reference attribute.', default_value='as_in_settings', allowed_values=( 'phi_0_abs', 'phi_0_rel', 'phi_s', 'as_in_original_dat', 'as_in_settings'), is_mandatory=True, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='reference_phase_policy', types=(<class 'str'>,), description='Controls cavities reference phase. More ' 'details in :ref:`dedicated ' 'notebook<notebooks-cavities-reference-phase>`. ' 'With TraceWin solver, prefer sticking with ' "`'phi_0_rel'`.", default_value='phi_0_rel', allowed_values=( 'phi_0_abs', 'phi_0_rel', 'phi_s', 'as_in_original_dat'), is_mandatory=True, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='flag_phi_abs', types=(<class 'bool'>, <class 'NoneType'>), description='DEPRECATED, prefer use of ' '`reference_phase_policy`. If the field maps ' 'phases should be absolute (no implicit ' 'rephasing after a failure).', default_value=None, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message='The ``flag_phi_abs`` option is deprecated, ' 'prefer using the ' '``reference_phase_policy``.\n' 'flag_phi_abs=False -> ' "reference_phase_policy='phi_0_rel'\n" 'flag_phi_abs=True -> ' "reference_phase_policy='phi_0_abs'", error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='tool', types=(<class 'str'>,), description='Name of the tool.', default_value='Envelope1D', allowed_values=( 'Envelope1D', 'Envelope3D', 'Envelope_1D', 'Envelope_3D', 'TraceWin', 'envelope1d', 'envelope3d', 'envelope_1d', 'envelope_3d', 'tracewin'), is_mandatory=True, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='algo', types=(<class 'int'>,), description='Optimization using algorithm (0: Owner, 1: ' 'Simplex, 2: Diff. evo.)', default_value=0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='alpx1', types=(<class 'float'>,), description='Input twiss parameter alpXX’ of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='alpx2', types=(<class 'float'>,), description='Input twiss parameter alpXX’ of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='alpy1', types=(<class 'float'>,), description='Input twiss parameter alpYY’ of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='alpy2', types=(<class 'float'>,), description='Input twiss parameter alpYY’ of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='alpz1', types=(<class 'float'>,), description='Input twiss parameter alpZZ’ of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='alpz2', types=(<class 'float'>,), description='Input twiss parameter alpZZ’ of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='betx1', types=(<class 'float'>,), description='Input twiss parameter betXX’ of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='betx2', types=(<class 'float'>,), description='Input twiss parameter betXX’ of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='bety1', types=(<class 'float'>,), description='Input twiss parameter betYY’ of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='bety2', types=(<class 'float'>,), description='Input twiss parameter betYY’ of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='betz1', types=(<class 'float'>,), description='Input twiss parameter betZZ’ of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='betz2', types=(<class 'float'>,), description='Input twiss parameter betZZ’ of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='cancel_matching', types=(<class 'bool'>,), description='Cancel all matching procedure (Envelope)', default_value=False, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='cancel_matchingP', types=(<class 'bool'>,), description='Cancel all matching procedure (Tracking)', default_value=False, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='charge1', types=(<class 'float'>,), description='Input particle charge state of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='charge2', types=(<class 'float'>,), description='Input particle charge state of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='current1', types=(<class 'float'>,), description='Input beam current (mA) of main beam', default_value=0.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='current2', types=(<class 'float'>,), description='Input beam current (mA) of second beam', default_value=0.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='dst_file1', types=(<class 'str'>, <class 'pathlib.Path'>), description='Full name Input dst of main beam (*)', default_value='', allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=True, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='dst_file2', types=(<class 'str'>, <class 'pathlib.Path'>), description='Full name Input dst of second beam (*)', default_value='', allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=True, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='duty1', types=(<class 'float'>,), description='Duty cycle of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='duty2', types=(<class 'float'>,), description='Duty cycle of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='dw1', types=(<class 'float'>,), description='Input Dw of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='dw2', types=(<class 'float'>,), description='Input Dw of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='eln1', types=(<class 'float'>,), description='Input ZZ’ emittance (mm.mrad) of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='eln2', types=(<class 'float'>,), description='Input ZZ’ emittance (mm.mrad) of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='emit_e_limit', types=(<class 'float'>,), description='Particle is excluded form emit. calculation if ' '\\|W-Ws\\|/ Ws > emit_e_limit', default_value=0.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='emit_p_limit', types=(<class 'float'>,), description='Particle is excluded form emit. calculation if ' '\\|Ф- Ф s\\| > emit_p_limit', default_value=0.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='energy1', types=(<class 'float'>,), description='Input kinetic energy (MeV) of main beam', default_value=100.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='energy2', types=(<class 'float'>,), description='Input kinetic energy (MeV) of second beam', default_value=100.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='etnx1', types=(<class 'float'>,), description='Input XX’ emittance (mm.mrad) of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='etnx2', types=(<class 'float'>,), description='Input XX’ emittance (mm.mrad) of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='etny1', types=(<class 'float'>,), description='Input YY’ emittance (mm.mrad) of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='etny2', types=(<class 'float'>,), description='Input YY’ emittance (mm.mrad) of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='freq1', types=(<class 'float'>,), description='Input beam frequency (MHz) of main beam', default_value=100.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='freq2', types=(<class 'float'>,), description='Input beam frequency (MHz) of second beam', default_value=100.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='hide', types=(<class 'bool'>,), description='Hide the GUI, or cancel console output (no ' 'parameter).', default_value=True, allowed_values=None, is_mandatory=True, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='input_dist_type', types=(<class 'int'>,), description='Input distribution type from 1 to 5, see GUI ' 'menu', default_value=1, allowed_values=range(1, 6), is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='long_dist_mask', types=(<class 'int'>,), description='Mask of the longitudinal input distribution ' 'from 1 to 7, see GUI menu', default_value=1, allowed_values=range(1, 8), is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='lost_e_limit', types=(<class 'float'>,), description='Particle is lost if \\|W-Ws\\| > lost_e_limit', default_value=0.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='lost_p_limit', types=(<class 'float'>,), description='Particle is lost if \\|Ф- Ф s\\| > ' 'lost_p_limit', default_value=0.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='mass1', types=(<class 'float'>,), description='Input beam mass (eV) of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='mass2', types=(<class 'float'>,), description='Input beam mass (eV) of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='nbr_part1', types=(<class 'int'>,), description='Number of particle of main beam', default_value=100, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='nbr_part2', types=(<class 'int'>,), description='Number of particle of second beam', default_value=100, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='nbr_thread', types=(<class 'int'>,), description='Set the max. number of core/thread used', default_value=8, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='partran', types=(<class 'int'>, <class 'bool'>), description='To activate/deactivate partran tracking.', default_value=0, allowed_values=(0, 1, True, False), is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='part_step', types=(<class 'int'>,), description='Partran calculation step per meter (per ' 'beta.lambda if < 0)', default_value=20, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='picnic_2d', types=(<class 'bool'>,), description='Space-charge routine is defined as picnic2D', default_value=False, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='picnic_3d', types=(<class 'bool'>,), description='Space-charge routine is defined as picnic3D', default_value=False, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='picnic_r_mesh', types=(<class 'float'>,), description='R mesh of picnic 2D', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='picnic_xy_mesh', types=(<class 'float'>,), description='X&Y mesh of picnic 3D', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='picnic_z_mesh', types=(<class 'float'>,), description='Z mesh of picnic 3D', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='picnir_z_mesh', types=(<class 'float'>,), description='Z mesh of picnir 2D', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='random_seed', types=(<class 'int'>,), description='Set the random seed', default_value=0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='spreadw1', types=(<class 'float'>,), description='Input spread energy for CW beam of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='spreadw2', types=(<class 'float'>,), description='Input spread energy for CW beam of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='synoptic_file', types=(<class 'str'>, <class 'pathlib.Path'>), description='Save the geometric layout at (entance (=1), ' 'middle (=2), exit (=3) of elements. (See ' '“Synoptic” tools for file name).', default_value=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/lightwin/envs/latest/lib/python3.12/site-packages/lightwin/data/ads/.syn.ini'), allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message='Not sure of this argument meaning.', error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='tab_file', types=(<class 'str'>, <class 'pathlib.Path'>), description='Save to file the data sheet at the end of ' 'calcul (by default in calculation directory).', default_value=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/lightwin/envs/latest/lib/python3.12/site-packages/lightwin/data/ads/.tab.ini'), allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message='Not sure of this argument meaning.', error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='toutatis', types=(<class 'float'>, <class 'bool'>), description='Force or avoid Toutatis simulation (1 / 0)', default_value=0, allowed_values=(0, 1, True, False), is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='trans_dist_mask', types=(<class 'int'>,), description='Mask of the transverse input distribution from ' '1 to 7, see GUI menu', default_value=1, allowed_values=range(1, 8), is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='upgrade', types=(<class 'str'>,), description='To update LightWin', default_value='', allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message='Upgrading TraceWin from LightWin is a bad ' 'idea.', overrides_previously_defined=False, derived=False), KeyValConfSpec(key='use_dst_file', types=(<class 'bool'>,), description='dst file is used as input beam distribution', default_value=True, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='vfac', types=(<class 'float'>,), description='Change RFQ Ucav (ex : “vfac 0.5”, half reduce ' 'of Ucav)', default_value=0.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='x1', types=(<class 'float'>,), description='Input X position of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='x2', types=(<class 'float'>,), description='Input X position of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='xp1', types=(<class 'float'>,), description='Input X angle of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='xp2', types=(<class 'float'>,), description='Input X angle of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='y1', types=(<class 'float'>,), description='Input Y position of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='y2', types=(<class 'float'>,), description='Input Y position of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='yp1', types=(<class 'float'>,), description='Input Y angle of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='yp2', types=(<class 'float'>,), description='Input Y angle of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='z1', types=(<class 'float'>,), description='Input Z position of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='z2', types=(<class 'float'>,), description='Input Z position of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='zp1', types=(<class 'float'>,), description='Input Z angle of main beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='zp2', types=(<class 'float'>,), description='Input Z angle of second beam', default_value=-1.0, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='base_kwargs', types=(<class 'dict'>,), description='Keyword arguments passed to TraceWin CLI. ' 'Internal use of LightWin onnly.', default_value={}, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message='Providing `base_kwargs` is not ' 'recommended.', error_message=None, overrides_previously_defined=False, derived=True), KeyValConfSpec(key='executable', types=(<class 'str'>, <class 'pathlib.Path'>), description='Direct path to the TraceWin executable. If ' 'given, will override the definition in the ' 'machine_config_file.', default_value='', allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=True, action=None, warning_message='Providing `executable` will override ' '`machine_config_file` settings.', error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='ini_path', types=(<class 'str'>, <class 'pathlib.Path'>), description='Path to the `INI` TraceWin file.', default_value=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/lightwin/envs/latest/lib/python3.12/site-packages/lightwin/data/ads/ads.ini'), allowed_values=None, is_mandatory=True, is_a_path_that_must_exists=True, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='machine_config_file', types=(<class 'str'>, <class 'pathlib.Path'>), description='Path to a file holding the paths to TW ' 'executables', default_value=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/lightwin/envs/latest/lib/python3.12/site-packages/lightwin/data/ads/machine_config.toml'), allowed_values=None, is_mandatory=True, is_a_path_that_must_exists=True, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='machine_name', types=(<class 'str'>,), description='Name of current machine. Must be a table name ' 'in `machine_config_file`. By default, do not ' 'provide it and let LightWin handle this part.', default_value=None, allowed_values=None, is_mandatory=False, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False), KeyValConfSpec(key='simulation_type', types=(<class 'str'>,), description='A key in the machine_config.toml file', default_value='noX11_full', allowed_values=None, is_mandatory=True, is_a_path_that_must_exists=False, action=None, warning_message=None, error_message=None, overrides_previously_defined=False, derived=False)): Arguments for TraceWin object configuration

tracewin_pre_treat(self, toml_table, **kwargs)[source]

Set the TW executable.

Parameters:

self (TableConfSpec)
toml_table (dict[str, Any])

Return type:

None

tracewin_declare_that_machine_config_is_not_mandatory_anymore(self)[source]

Update configuration to avoid checking some entries.

Parameters:: self (TableConfSpec)
Return type:: None

tracewin_post_treat(self, toml_subdict, **kwargs)[source]

Separate TraceWin/LightWin arguments.

Parameters:

self (TableConfSpec)
toml_subdict (dict[str, Any])

Return type:

None

_get_tracewin_executable(toml_folder, machine_config_file, simulation_type, machine_name='', **toml_subdict)[source]

Check that the machine config file is valid.

Parameters:

toml_folder (Path)
machine_config_file (str | Path)
simulation_type (str | Path)
machine_name (str | Path, default: '')

Return type:

Path