vastorbit.get_option

vastorbit.get_option(key: str) → Any

Returns the value of a specified option.

Parameters:

key (str) – Option name.

Returns:

The selected option.

Return type:

Any

Examples

Let’s get the value of an existing option.

# Importing the function
from vastorbit._config.config import get_option

# Checking the 'plotting_lib' option
get_option('plotting_lib')

Note

This function is utilized to get the options that can be used throughout the entire API.

See also

set_option() : Sets vastorbit options.