Environment Variables

On this page

Environment Variables#

Internal and external (third-party) environment variables for either a user, a developer, or are set by default on a specific host platform e.g., a GitHub runner.

Internal#

Package environment variables that influence the behaviour of geovista:

Table 1: Internal Variables#

Name

Type

Description

GEOVISTA_CACHEDIR

User

Configures the root directory (absolute path) where geovista resources will be downloaded and cached. See GEOVISTA_CACHEDIR.

Defaults to the geovista sub-directory under the user and platform specific cache directory returned by platformdirs.user_cache_dir().

GEOVISTA_DATA_VERSION

User

Configures the version of data resources to be downloaded and cached from the BASE_URL. See GEOVISTA_DATA_VERSION.

Defaults to the specific DATA_VERSION bundled with the version of geovista.

GEOVISTA_DOWNLOAD

Developer

Set within the tests, linkcheck and doctest GitHub Action runners with the required command for tox to download, decompress and cache geovista resources.

GEOVISTA_IMAGE_TESTING

Developer

When set, the geovista.theme will not be loaded and geovista.gridlines will not show labels.

This allows image testing to be more robust, particularly by being independent of any geovista theme changes.

Image tests default to using the pyvista testing theme.

GEOVISTA_POOCH_MUTE

User

Controls the verbosity level of the geovista CACHE manager. Set to True to silence the pooch logger diagnostic warnings. See GEOVISTA_POOCH_MUTE and also pooch_mute().

Defaults to False.

GEOVISTA_VTK_WARNINGS

User

Set to True to enable backend VTK diagnostic warnings.

Defaults to False.

Third-Party#

Notable third-party environment variables that influence the behaviour of geovista:

Table 2: External Variables#

Name

Type

Description

CI

Platform

Default environment variable set on a GitHub Action runner.

Used by geovista to start an X virtual frame buffer display server via pyvista.start_xvfb().

EAGER_IMPORT

User

Set this environment variable to disable lazy loading of geovista subpackages and external libraries.

Deferred imports are enabled by default in geovista.

For further details see lazy-loader and SPEC 1.

PYVISTA_BUILDING_GALLERY

Developer

Set to true when building the documentation sphinx-gallery.

READTHEDOCS

Platform

Default environment variable set on a Read the Docs runner.

Used by geovista to start an X virtual frame buffer display server via pyvista.start_xvfb().

XDG_CACHE_HOME

User

Configures the root directory (absolute path) where geovista resources will be downloaded and cached.

Overrides GEOVISTA_CACHEDIR.

For further details see XDG Base Directory Specification.