simpeg.utils.deprecate_method

simpeg.utils.deprecate_method(method, old_name, removal_version=None, future_warn=False, error=False)

Deprecate method

Parameters:

methodmethod

Current method

old_namestr

Original name for the now deprecated method

removal_versionstr, optional

SimPEG version in which the method will be removed from the code base

future_warnbool, default: False

If True, throw comprehensive warning the method will be deprecated

errorbool, default: False

Throw error if deprecated method no longer implemented

Returns:

method

The new method