Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Arnold for Katana plugin comes with Arnold core bundled but without the SDK. Setting it up generally requires pointing to your license server(s), setting KATANA_RESOURCES, and And launching Katana.

Installing KtoA

...

Run the downloaded installer, which will pop up a window to walk you through the installation process.  You should have installed your desired Katana version previously.

...

KtoA has a bundled script for launching KtoA with your desired version of Katana.  It is recommended to customize that script (or a copy of it) for your environment , and use it or a shortcut to it to launch KtoA.  See the files launchKtoA.sh (Linux) and launchKtoA.bat (Windows) for a typical launch script.

KtoA comes bundled with Arnold core and is tuned to work with the version it is bundled with.  It also has additional plugins, such as common shaders, volume plugins (OpenVDB volumes), kick, the Arnold Python API, and so on.  Generally, to launch Katana with KtoA, you just need to expand the KtoA tarball and set the following environment variables, customized to your environment (the PATH and license variables are not required):

...

On Linux, after installing Katana and downloading KtoA, the following environment variables ought to be set, and an example of each is given:

  • KTOA_ROOT is a convenience convenient for setting the other environment variables; neither KtoA nor Katana make direct use of it.
  • PATH could be modified to include at least the KtoA bin directory and directory, and additionally, you can include $KATANA_HOME as well to place the katana binary in your path for convenience.
  • KATANA_RESOURCES should be set or modified to include the KtoA renderer resources; this is simply the path to the KtoA installation directory.

On Linux, if If you are using a bash shell on Linux, you should consider creating a script to set the main environment variables and launch Katana for you.

Multiexcerpt
hiddentrue

Configuring USD Plugins

Katana to Arnold KtoA ships with multiple USD plugins, a Render Delegate, a Node Registry Plugin, a custom build of Foundry's KatanaUsdPlugins, and plugins for UsdIn. These plugins can be activated by either using the launch scripts or manually setting the environment variables listed below.

Render Delegate and Node Registry plugin

Katana to Arnold KtoA includes two components from Arnold-USD to allow using Arnold directly in the Hydra Viewport.

On Linux:

Code Block
languagebash
export "FNPXR_PLUGINPATH=${KTOA_ROOT}/USD/Viewport:${FNPXR_PLUGINPATH}"

On Windows:

Code Block
set "FNPXR_PLUGINPATH=%KTOA_HOME%\USD\Viewport;%FNPXR_PLUGINPATH%"

 

Katana USD Plugins

KtoA includes a custom build of Foundry's Katana USD Plugins, which replaces Katana's one when using the launch scripts. There is also a set of plugins for UsdIn, named KatanaUsdArnold, included in the installation. These allow importing Arnold specific information, like shaders, using UsdIn.

On Linux:

Code Block
languagebash
export "LD_LIBRARY_PATH=${KTOA_ROOT}/USD/KatanaUsdPlugins/lib:${KTOA_ROOT}/USD/KatanaUsdPlugins/plugin/Libs:${KTOA_ROOT}/USD/KatanaUsdArnold:${LD_LIBRARY_PATH}"
export "KATANA_RESOURCES=${KTOA_ROOT}/USD/KatanaUsdPlugins/plugin:${KATANA_RESOURCES}"

 

On Windows:

Code Block
set "path=%KTOA_HOME%\USD\KatanaUsdPlugins\lib;%KTOA_HOME%\USD\KatanaUsdPlugins\plugin\Libs;%path%"
set "KATANA_RESOURCES=%KTOA_HOME%\USD\KatanaUsdPlugins\plugin;%KTOA_HOME%\USD\KatanaUsdArnold;%KATANA_RESOURCES%"
Note

The customizations applied to the Foundry plugin can be found here.

 

More Environment Variables

...

  • KTOA_LOAD_VERBOSITY: how chatty do you want Arnold to be when loading shaders/plugins for eplugins e.g. for Katana material nodes.  Values are quiet, normal, and debug, where debug is the default.  This can help diagnose issues such as missing shaders or OSL shaders that can't be compiled.
  • PYTHONPATH: you may want to extend this to include the python subdirectory of your Arnold installation ($KTOA_ROOT/python)
  • (deprecated) ARNOLD_SHADERLIB_PATH: you may extend the areas that Katana searches for your Arnold shaders with this variable
  • ARNOLD_PLUGIN_PATH: you may extend the directories that KtoA searches for your Arnold shaders, procedurals, volumes, drivers, etc. plugins
  • PATH: if you wish to use kick or maketx directly from KtoA, please append to this the path to the bin subdirectory of KtoA
  • LD_LIBRARY_PATH: usually does not need to be set, but to get access to libai.so it may be necessary to append the bin subdirectory of KtoA
  • (deprecated) ARNOLDTREE: This is not used anymore.  It is used to specify the path to your Arnold installation root. This is not used by Arnold itself, but by Katana's Arnold integration; if you do not set this, you could instead symlink the path from your Arnold installation to /usr/local/arnold

...

  • foundry_LICENSE is set to your port and license server for Katana, e.g. 4101@localhost 4101@localhost; please see The Foundry's documentation on licensing of Katana for more information
  • ADSKFLEX_LICENSE_FILE is set to your port@host for Autodesk CLM licensing of Arnold
  • solidangle_LICENSE is set to your port and license server for Arnold, e.g. 5053@localhost 5053@localhost; or, it is set to the path of your node-lock license file
  • (deprecated) ARNOLD_LICENSE_HOST is set to your license server for Arnold, possibly localhost
  • (deprecated) ARNOLD_LICENSE_PORT is set to your license server's port, usually 5053

...

© 2020-2021 Autodesk. All Rights Reserved / website terms / privacy/cookies / ccpa settings