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.
Classes#
- class eradiate._config.EradiateConfig(source_dir=Raise(), data_store_url='http://eradiate.eu/data/store/', download_dir='$ERADIATE_SOURCE_DIR/resources/downloads', 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
- 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.
- source_dir#
Path to the Eradiate source directory.
Attributes#
- eradiate._config.config#
Global configuration object instance. See
EradiateConfig
.