Share

Environment Variables - Arnold User Guide

Below is a list of environment variables used in Arnold.

Environment variable Definition
ADSKFLEX_LICENSE_FILE Specifies the location of the network license server.
ARNOLD_ADP_DISABLE Disables ADP (Autodesk Analytics) for the session. Set it to 0 to opt out of everything. Note that ARNOLD_ADP_DISABLE takes precedence over ARNOLD_ADP_OPTIN. It was added in 2022, so any version of Arnold older than Arnold 7.1.4 does not support it. For older versions of Arnold, there is ARNOLD_ADP_OPTIN. DISABLE takes precendence over OPTIN if you set both.
ARNOLD_ADP_OPTIN Set to 1 to opt-in; anything else will opt-out. Changes opt-in status permanently, allowing users to opt-in and out of everything. This is more for our big studio customers with render farms so that they can skip manually opting in/out of ADP with a GUI on each machine. It will enable ADP in order to register optin status and then disable it; this temporary enabling could cause issues so ARNOLD_ADP_DISABLE should instead be used if working around ADP bugs.
ARNOLD_FORCE_ABORT_ON_LICENSE_FAIL Set to 0 to disable aborting when license checkout fails. Any other value forces an abort.
ARNOLD_AUTO_GENERATE_TX This option will override the value of the options.texture_auto_generate_tx global option. This variable can only take two possible values (text strings) for now: never, which disables autotx, and when_outdated, which enables autotx with the current behaviour (updating TX files only when they are outdated).
ARNOLD_CER_AUTOSEND_EMAIL Enables silent CER reporting by providing an e-mail address to use for CER reports. This can be useful for reporting crashes from batch rendering processes and render farms.
ARNOLD_CER_ENABLED To enable Crash Error Reporting (CER), set to on, true, oryes (capitalization doesn't matter). To disable CER, set to off, false, or no.
ARNOLD_MATERIALX_NODE_DEFINITIONS A list of paths loaded by MaterialX as libraries, if a path is a folder, the content of the path will be loaded.
ARNOLD_MATERIALX_SEARCH_PATH A list of paths used to search for libraries when included by a document.
ARNOLD_PATHMAP A json file with the path mapping rules for Arnold.
ARNOLD_PLUGIN_PATH A list of folders that contain Arnold plugins and procedurals. Can be : or ; separated.
ARNOLD_SYSTEM_HANDLER_MASK Set this to 0 in order to prevent the Arnold crash handler from being invoked during a crash.
OCIO Specifies the OCIO configuration file to use when no configuration file is set in the OpenColorIO color manager.
OPENVDB_DISABLE_DELAYED_LOAD Turns off delay loading of OpenVDB files. This should result in faster volume loading into Arnold, especially on multi-socket and high core count machines. The downside is that it will load in the entire volume, so partially visible volumes (say half the volume is under the ground) would consume more memory.
OPTIX_CACHE_PATH Folder used for the GPU cache.
PROCEDURAL_USE_HYDRA Controls whether the Hydra framework is used for translating USD data during rendering. Set this variable to 0 to revert to the older translation method.
PXR_MTLX_STDLIB_SEARCH_PATHS A USD environment variable that makes USD aware of custom materialx definitions. To reference your own MaterialX shaders from a USD file, you need to add your MaterialX files to this variable.

Was this information helpful?