Configuration environment variables

from earthkit.data import config

For the rest of this notebook we disable the Configuration autosave so the changes will not be written into our configuration file.

config.autosave = False

Each Configuration parameter has a corresponding environment variable (see the full list here). When an environment variable is set, it takes precedence over the settings parameter as the following example demonstrates it.

Assuming no environmental variable is set the value is read form the config file.

config.get("url-download-timeout")

30

When the environment variable is set get returns its value.

%env EARTHKIT_DATA_URL_DOWNLOAD_TIMEOUT=26

env: EARTHKIT_DATA_URL_DOWNLOAD_TIMEOUT=26

config.get("url-download-timeout")

26

Setting the value generates a warning. The new value is saved into the config file, but get still returns the value of the environment variable.

config.set("url-download-timeout", 10)
config.get("url-download-timeout")

/Users/cgr/git/earthkit-data/src/earthkit/data/core/config.py:412: UserWarning: Config option 'url-download-timeout' is also set by environment variable 'EARTHKIT_DATA_URL_DOWNLOAD_TIMEOUT'.The environment variable takes precedence and its value is returned when calling get().
  warnings.warn(msg)

26

The env() method gives details about the set environment variables.

config.env()

{'url-download-timeout': ('EARTHKIT_DATA_URL_DOWNLOAD_TIMEOUT', '26')}

When we dump the configuration the values set via environment variables are clearly indicated.

config

Name	Value	Default
cache-policy	'user'	'off'
check-out-of-date-urls	True	True
download-out-of-date-urls	False	False
grib-file-serialisation-policy	'path'	'path'
grib-handle-cache-size	1	1
grib-handle-policy	'cache'	'cache'
maximum-cache-disk-usage	'98%'	'98%'
maximum-cache-size	None	None
number-of-download-threads	5	5
reader-type-check-bytes	64	64
temporary-cache-directory-root	None	None
temporary-directory-root	None	None
url-download-timeout	EARTHKIT_DATA_URL_DOWNLOAD_TIMEOUT='26' (10)	'30s'
use-grib-metadata-cache	True	True
use-message-position-index-cache	False	False
use-standalone-mars-client-when-available	True	True
user-cache-directory	'/var/folders/93/w0p869rx17q98wxk83gn9ys40000gn/T/earthkit-data-cgr'	'/var/folders/93/w0p869rx17q98wxk83gn9ys40000gn/T/earthkit-data-cgr'
version	'0.19.2.dev25+g34e3518fd.d20260302'	''