finesse.config module

Configuration tools.

exception finesse.config.ConfigNotFoundError

Bases: Exception

Indicates a Finesse configuration could not be loaded.

finesse.config.autoconfigure()

Automatically configure runtime options based on the environment.

finesse.config.config_instance()

The Finesse configuration object for the current session.

Returns

configparser.RawConfigParser

The Finesse configuration object.

finesse.config.configure(plotting=False, jupyter_tracebacks=None, progress_bars=False)

Configure Finesse runtime options.

Parameters

plottingbool, optional

Initialise Finesse plot theme for display.

jupyter_tracebacksbool, optional

Show full tracebacks in Finesse errors when using Finesse in IPython. This setting does not work reliably in other environments.

progress_barsbool, optional

When True progress bars will be displayed when available.

See Also

finesse.plotting.tools.init()