viperleed.calc.files.parameters.known_parameters

Module known_parameters of viperleed.calc.files.parameters.

Initial version by @fkraushofer in 2020, major rewrite by @amimre and @michele-riva in June 2023. This module used to be part of parameters.py. Refactored in October 2023.

Contains definitions of all known parameters and their supported aliases. It also defines useful functions for retrieving parameter names used internally when reading/writing/interpreting a PARAMETERS file.

Functions

did_you_mean(unknown_param)	Return one close match for unknown_param from the known ones.
from_alias(known_param_or_alias)	Return a parameter name, possibly from its alias.
is_deprecated(param, version)	Return whether param is deprecated for a ViPErLEED version.
warn_if_deprecated(param, version)	Emit a log warning if param is deprecated for version.