Environment Variables
Environment Variables
There are a handful of environment variables that RenderMan and its related tools depend on to function properly. Given a standard installation on OS X or Windows, the installer will take care of the critical variables. On Linux, as discussed in the installation documentation, users need to set these variables manually. RenderMan for Maya manages to circumvent the need for the variables in certain cases via its module file: RenderMan_for_Maya.module.
In addition, there are a number of other useful environment variables that you may or may not want to set depending on your needs, or temporarily. The table below enumerates and describes all the variables that are useful for RenderMan users.
Variables can be set via the usual mechanisms (.bashrc/.cshrc on Linux/Mac, or the Advanced system settings/System Properties on Windows...), and can be queried similarly, as well as through MEL in Maya. Users should also take care to make sure that their PATH is set up properly.
| Variable | Default Setting (if applicable) | Description |
|---|---|---|
| RMANTREE (external) | Linux: /opt/pixar/RenderManProServer-[version] Mac: //Applications/Pixar/RenderMan.app/Versions/RenderManProServer-[version] Windows: C:\Program Files\Pixar\RenderManProServer-[version]\ |
Tells PRMan where to find its components, e.g. txmake, the prman executable, ptfilter, etc. Note that the RMANTREE changes when rendering via the internal renderer with the RenderMan for Maya plugin (see below). |
| RMANTREE (internal) | Linux: $RMSTREE/rmantree Mac: $RMSTREE/rmantree Windows: %RMSTREE%\rmantree |
See above. |
| RMSTREE | Linux: /opt/pixar/RenderManStudio-[version]-maya[version] Mac: //Applications/Pixar/RenderManStudio-[version]-maya[version] Windows: C:\Program Files\Pixar\RenderManStudio-[version]-maya[version] |
Sets the root location for all components of RenderMan for Maya. RMSTREE and RMANTREE are the most important settings for the application and great care must be taken to ensure that they are properly set for your project, particularly in environments where multiple versions of the software may be in use. |
| RMSDEBUG (optional) | n/a | Sets the debug output level, 1 being least copious and 6 being most. This can also be set on a per-tool basis, like so: setenv RMSDEBUG slim:6 It is equivalent to RATDEBUG. |
| MAYA_PLUG_IN_PATH | $RMSTREE/plug-ins | Tells Maya where to look for the RenderMan for Maya plugin. |
| MAYA_SCRIPT_PATH | $RMSTREE/scripts | |
| MAYA_MODULE_PATH | C:\Program Files\Pixar\RenderManStudio-<version>-maya<version>\etc | This variable shouldn't be necessary on OS X and Linux as the RenderMan_for_Maya.module file should be referenced via a symlink. The Windows installer sets this as part of the installation process. |
| RMS_SCRIPT_PATHS (optional) | n/a | RMS_SCRIPT_PATHS is used to reference extensions to the plugin that have been stored in alternate locations, e.g. site-specific .ini files that may be used for customized preferences, specialized "It" scripts, et cetera. |
| MAYA_LOCATION (optional, depending on platform) | n/a | Sets the location of Maya. RfM and RMS use certain Maya libraries and this variable indicates where to find them. |
| PYTHONPATH (optional) | $RMSTREE/scripts:$RMANTREE/bin | Sets the Python location. Users who already have a PYTHONPATH set should append this as needed. |
| PIXAR_LICENSE_FILE (quasi-optional) | n/a | Points to the location of the pixar.license file. It is only needed if the license is not installed in the default location. |