beam_specs module

Define parameters necessary to define a beam.

Note

Several parameters hold the derived flag. It means that these quantities are calculated from other parameters by LightWin, and should not be handled by the user.

class BeamTableConfSpec(configured_object, table_entry, specs, is_mandatory=True, can_have_untested_keys=False, selectkey_n_default=None, monkey_patches=None)

Bases: TableConfSpec

Set the specifications for the beam.

We subclass TableConfSpec to define some keys requiring a specific treatment.

Parameters:

• configured_object (Literal['beam', 'beam_calculator', 'beam_calculator_post', 'design_space', 'evaluators', 'files', 'plots', 'wtf'])

• table_entry (str)

• specs (Collection[KeyValConfSpec] | dict[str, Collection[KeyValConfSpec]] | dict[bool, Collection[KeyValConfSpec]])

• is_mandatory (bool, default: True)

• can_have_untested_keys (bool, default: False)

• selectkey_n_default (tuple[str, str | bool] | None, default: None)

• monkey_patches (dict[str, dict[str, Callable]] | dict[bool, dict[str, Callable]] | None, default: None)

_pre_treat(toml_subdict, **kwargs)

Edit some values, create new ones.

Parameters:

toml_subdict (dict[str, Any])

Return type:

None

_validate(toml_subdict, **kwargs)

Add validations to the default ones.

Parameters:

toml_subdict (dict[str, Any])

Return type:

bool