beam_calculator_base_specs module

Define configuration entries that are common to all BeamCalculator.

BEAM_CALCULATOR_BASE_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))

Configuration entries common to all beam calculators.