Settings

This module contains setters and getters for various package-wide settings. These settings are not remembered between Python sessions.

trueq.settings.set_cl(cl)

Sets the default confidence level of several output displays.

Parameters

cl (float) – A number between zero and one, usually close to one.

Raises

ValueError – If the argument is not in \((0,1)\).

trueq.settings.get_cl()

Returns the default confidence level of several output displays.

Return type

py:class:float

trueq.settings.get_zl()

Returns the value \(z\) such that the probability mass between \([-z,z]\) of the unit normal distribution is equal to the current confidence level, see get_cl() and set_cl(). This is used by several output displays.

Return type

float

trueq.settings.set_dim(dim)

Sets the default subsystem dimension for several constructors, such as Cycle, Results, Twirl, WeylBase and its children.

Parameters

dim (int) – An integer greater than or equal to two.

Raises

ValueError – If dim is not an integer greater than or equal to two.

trueq.settings.get_dim()

Gets the default dimension for several class constructors, see set_dim().

Return type

int

trueq.settings.reset()

Resets all settings to their original values.