simpeg.utils.deprecate_module#
- simpeg.utils.deprecate_module(old_name, new_name, removal_version=None, future_warn=False, error=False)[source]#
Deprecate module
- Parameters:
- old_name
str
Original name for the now deprecated module
- new_name
str
New name for the module
- removal_version
str
,optional
SimPEG version in which the module will be removed from the code base
- future_warnbool, default:
False
If
True
, throw comprehensive warning the module will be deprecated- errorbool, default:
False
Throw error if deprecated module no longer implemented
- old_name