Logo Iris 1.12

Previous topic

iris.aux_factory

Next topic

iris.coord_categorisation

This Page

iris.config

Provides access to Iris-specific configuration values.

The default configuration values can be overridden by creating the file iris/etc/site.cfg. If it exists, this file must conform to the format defined by ConfigParser.


iris.config.SAMPLE_DATA_DIR

Local directory where sample data exists. Defaults to “sample_data” sub-directory of the Iris package install directory. The sample data directory supports the Iris gallery. Directory contents accessed via iris.sample_data_path().

Deprecated since version 1.10.

iris.config.TEST_DATA_DIR

Local directory where test data exists. Defaults to “test_data” sub-directory of the Iris package install directory. The test data directory supports the subset of Iris unit tests that require data. Directory contents accessed via iris.tests.get_data_path().

iris.config.PALETTE_PATH

The full path to the Iris palette configuration directory

iris.config.IMPORT_LOGGER

The [optional] name of the logger to notify when first imported.

iris.config.RULE_LOG_DIR

The [optional] full path to the rule logging directory used by iris.fileformats.pp.load() and iris.fileformats.pp.save().

Deprecated since version 1.10.

iris.config.RULE_LOG_IGNORE

The [optional] list of users to ignore when logging rules.

Deprecated since version 1.10.


In this module:

iris.config.get_dir_option(section, option, default=None)

Returns the directory path from the given option and section, or returns the given default value if the section/option is not present or does not represent a valid directory.

↑ top ↑

iris.config.get_option(section, option, default=None)

Returns the option value for the given section, or the default value if the section/option is not present.