eradiate._config

Contents

`eradiate._config`#

Global configuration components. The centric part is the EradiateConfig class, whose defaults can be set using environment variables. A single instance config is aliased in the top-level module for convenience.

Environment variable list

Classes#

class eradiate._config.EradiateConfig(source_dir=None, small_files_registry_url='https://raw.githubusercontent.com/eradiate/eradiate-data', small_files_registry_revision='master', data_store_url='http://eradiate.eu/data/store/', download_dir=None, offline=False, progress='KERNEL', azimuth_convention='EAST_RIGHT')[source]#

Global configuration for Eradiate.

This class, instantiated once as the eradiate.config attribute, contains global configuration parameters for Eradiate. It is initialized using environment variables as defaults.

See also

eradiate.config, the environ-config library

azimuth_convention#: The convention applied when interpreting azimuth values as part of the specification of a direction (see AzimuthConvention). Values are preferably set using strings (e.g. "EAST_RIGHT", "NORTH_LEFT", etc.).

data_store_url#: URL where large data files are located.

download_dir#: Path to the Eradiate download directory.

offline#: If True, activate the offline mode. All online data stores will be disconnected.

progress#: An integer flag setting the level of progress display (see ProgressLevel). Values are preferably set using strings (["NONE", "SPECTRAL_LOOP", "KERNEL"]). Only affects tqdm-based progress bars.

small_files_registry_revision#: Revision of the small files registry (production use only)

small_files_registry_url#: URL where small data files are located (production use only)

source_dir#: Path to the Eradiate source directory.

class eradiate._config.ProgressLevel(value)[source]#

An enumeration defining valid progress levels.

This is an integer enumeration, meaning that levels can be compared.

NONE = 0#: No progress

SPECTRAL_LOOP = 1#: Up to spectral loop level progress

KERNEL = 2#: Up to kernel level progress

Attributes#

eradiate._config.config#: Global configuration object instance. See EradiateConfig.