settings.rst

Settings

CliMetLab is maintaining a set of global settings which control its behaviour.

The settings are saved in ~/.climetlab/settings.yaml. They can be accessed from Python or using the climetlab command line as shown below:

Add documentation for command line usage.

Accessing settings

CliMetLab settings can be accessed using the python API:

settings-1-get.py

Or through the command line interface.

$ climetlab settings cache-directory

Or using the climetlab interactive prompt:

$ climetlab
(climetlab) settings cache-directory

Changing settings

Note

It is recommended to restart your Jupyter kernels after changing or resetting settings.

CliMetLab settings can be modified using the python API:

settings-2-set.py

Or through the command line interface (CLI). Note that changing settings containing dictionary values is not possible with the CLI.

$ climetlab settings cache-directory /big-disk/climetlab-cache

Or using the climetlab interactive prompt:

$ climetlab
(climetlab) settings cache-directory /big-disk/climetlab-cache

Resetting settings

Note

It is recommended to restart your Jupyter kernels after changing or resetting settings.

CliMetLab settings can be reset using the python API:

settings-3-reset.py

Or through the command line interface (CLI):

$ climetlab settings_reset cache-directory
$ climetlab settings_reset --all

Or using the climetlab interactive prompt:

$ climetlab
(climetlab) settings_reset
To wipe the cache completely, please use the --all flag. Use --help for more information.
(climetlab) settings_reset --all
(climetlab) Ctrl^D

Default values

generate_settings_rst