ktk.change_defaults

ktk.change_defaults#

change_defaults(change_ipython_dict_repr=True, change_matplotlib_defaults=True, change_numpy_print_options=True, change_warnings_format=True)[source]#

Enable Kinetics Toolkit’s lab goodies.

This function does not affect Kinetics Toolkit’s inner workings. It exists mostly for cosmetic reasons, so that working with ktk in an IPython console (e.g., Spyder, Jupyter) is more enjoyable. It changes IPython, Matplotlib, and numpy’s defaults for the current session only. The usual way to call it is right after importing Kinetics Toolkit.

Parameters:

  • change_ipython_dict_repr (bool) –

    Optional. True to summarize default dictionary printouts in IPython. When False, dictionary printouts look like:

    {'data1': array([ 0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14, 15, 16,
                 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29]),
 'data2': array([  0,   1,   4,   9,  16,  25,  36,  49,  64,  81, 100, 121, 144,
                 169, 196, 225, 256, 289, 324, 361, 400, 441, 484, 529, 576, 625,
                  676, 729, 784, 841])}

    When True, dictionary printouts look like:

    {
    'data1': <array of shape (30,)>
    'data2': <array of shape (30,)>
}

  • change_matplotlib_defaults (bool) – Optional. True to change default figure size, autolayout, dpi, line width, and colour order in Matplotlib. The dpi and figure size are optimized for interactive work in default Matplotlib figures. Additionally, the default colour order is changed to (rgbcmyko). The first colours, (rgb), are consistent with the colours assigned to x, y, and z in most 3D visualization software.

  • change_numpy_print_options (bool) – Optional. True to change default print options in numpy to use fixed point notation in printouts.

  • change_warnings_format (bool) – Optional. True to change the warnings module’s default to a more extended format with file and line number.

Return type:

None

Note

This function is called automatically when importing Kinetics Toolkit in lab mode:

import kineticstoolkit.lab as ktk