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:
Name |
Type |
Description |
|---|---|---|
GEOVISTA_CACHEDIR |
|
Configures the root directory (absolute path) where
Defaults to the |
GEOVISTA_DATA_VERSION |
|
Configures the version of data resources to be downloaded
and cached from the Defaults to the specific
|
GEOVISTA_DISABLE_PLOT_THEME |
|
When set, a plotting theme will not be loaded whenever
By default the Also see |
GEOVISTA_IMAGE_TESTING |
|
When set, plotting themes will not be loaded whenever
This allows image testing to be more robust, particularly
by being independent of any Image tests default to using the
|
GEOVISTA_POOCH_MUTE |
|
Controls the verbosity level of the Defaults to |
GEOVISTA_SPHX_GLR_SERIAL |
|
When set, the sphinx-gallery examples run one at a time instead of in parallel. Defaults to running in parallel with up to four workers. See Gallery. |
GEOVISTA_VTK_WARNINGS |
|
Set to Defaults to |
Third-Party#
Notable third-party environment variables that influence the behaviour of
geovista:
Name |
Type |
Description |
|---|---|---|
CI |
|
Default environment variable set on a GitHub Action runner. |
EAGER_IMPORT |
|
Set this environment variable to disable lazy
loading of Deferred imports are enabled by default in
For further details see lazy-loader and SPEC 1. |
PYVISTA_BUILDING_GALLERY |
|
Set to |
PYVISTA_OFF_SCREEN |
|
Set this environment variable to enable off-screen rendering. |
PYVISTA_PLOT_THEME |
|
Set this environment variable to the name of a
registered pyvista plot theme to be loaded and
enabled. Overrides the initial default configuration of
the May also be set to the |
READTHEDOCS |
|
Default environment variable set on a Read the Docs runner. |
XDG_CACHE_HOME |
|
Configures the root directory (absolute path) where
Overrides For further details see XDG Base Directory Specification. |