utils.get_option

seismostats.utils.get_option(key: str) → Any

Gets the value of the specified option.

Available options:

• ‘warnings’: bool (default: True)

  If True, warnings will be shown.

Parameters:

key – The option to get. Available options are ‘warnings’.

Returns:

value – The value of the option.

Examples

>>> from seismostats.utils._config import get_option

>>> # Get the value of the 'warnings' option
>>> warnings = get_option('warnings')