scipp.configuration.Config#

class scipp.configuration.Config#

Runtime configuration parameters.

Provides dict-like access to configuration parameters. Modifications apply to the current process only and do not modify any configuration files.

See https://scipp.github.io/reference/runtime-configuration.html

__init__()#

Methods

__init__()

config_dir()

Return the directory for configuration files.

config_path()

Return the path to the configuration file.

get()

Return parameters as a dict.

items()

Returns iterable over parameter names and values.

keys()

Returns iterable over parameter names.

values()

Returns iterable over parameter values.

config_dir()#

Return the directory for configuration files.

The directory is created if it does not already exist.

Return type

Path

config_path()#

Return the path to the configuration file.

The file may not exist but its folder is created if it does not already exist.

Return type

Path

get()#

Return parameters as a dict.

Return type

dict

items()#

Returns iterable over parameter names and values.

Return type

Iterable[Tuple[str, Any]]

keys()#

Returns iterable over parameter names.

Return type

Iterable[str]

values()#

Returns iterable over parameter values.

Return type

Iterable[Any]