unused_parameters¶
full name: tenpy.tools.params.unused_parameters
parent module:
tenpy.tools.params
type: function
-
tenpy.tools.params.
unused_parameters
(params, warn=None)[source]¶ Returns a set of the parameters which have not been read out with get_parameters.
This function might be useful to check for typos in the parameter keys.
- Parameters
params (dict) – A dictionary of parameters which was given to (functions using)
get_parameter()
warn (None | str) – If given, print a warning “unused parameter for {warn!s}: {unused_keys!s}”.
- Returns
unused_keys – The set of keys of the params which was not used
- Return type