firecrown.parameters.parameter_get_full_name

firecrown.parameters.parameter_get_full_name#

firecrown.parameters.parameter_get_full_name(prefix, param)[source]#

Form a full parameter name from the given (optional) prefix and name.

Parameter names, as stored in SACC, for example, contain an optional prefix; if a prefix is present, it will be separated from the name by an underscore.

Prefixes and names should avoid containing embedded underscores. This is currently not enforced in the code.

The parameter name can not be empty, even if accompanied by a prefix; this is enforced in the code.

Ill-formed parameter names result in raising a ValueError.

Parameters:
  • prefix (None | str) –

  • param (str) –

Return type:

str