..
  This file was automatically generated by docs/generate_rst_api.py. The

      make docs-rst-api

  target automates this process.


.. _sec-config-env_vars:

Environment variables
---------------------

.. envvar:: ERADIATE_SOURCE_DIR

   *Optional*. Path to the Eradiate source directory. If it is not set, then the current setup is assumed to be a production installation of Eradiate.

.. envvar:: ERADIATE_SMALL_FILES_REGISTRY_URL

   *Optional, default='https://raw.githubusercontent.com/eradiate/eradiate-data'.* URL where small data files are located (production use only)

.. envvar:: ERADIATE_SMALL_FILES_REGISTRY_REVISION

   *Optional, default='master'.* Revision of the small files registry (production use only)

.. envvar:: ERADIATE_DATA_STORE_URL

   *Optional, default='http://eradiate.eu/data/store/'.* URL where large data files are located.

.. envvar:: ERADIATE_DOWNLOAD_DIR

   *Optional*. Path to the Eradiate download directory.

.. envvar:: ERADIATE_OFFLINE

   *Optional*. If ``True``, activate the offline mode. All online data stores will be disconnected.

.. envvar:: ERADIATE_PROGRESS

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

.. envvar:: ERADIATE_AZIMUTH_CONVENTION

   *Optional, default='EAST_RIGHT'.* The convention applied when interpreting azimuth values as part of the specification of a direction (see :class:`.AzimuthConvention`). Values are preferably set using strings (*e.g.* ``"EAST_RIGHT"``, ``"NORTH_LEFT"``, etc.).