Page Information

Versions Compared

Key

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

The Arnold for Katana plugin comes in two flavors: Solid Angle's KtoA, and a minimal variant of that which ships with Katana and will already be available when Katana is installedwith Arnold core bundled, but without the SDK.  Setting it up generally requires pointing to your license server(s), setting KATANA_RESOURCES, and launching Katana.

KtoA

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):

Code Block
languagebash
export foundy_LICENSE=4101@localhost
export solidangle_LICENSE=5053@localhost
export DEFAULT_RENDERER=arnold
export "KATANA_TAGLINE=With KtoA and Arnold"
export KATANAKTOA_HOMEROOT=$USER/Katana-2.5v4/path/to/KtoA
export PATH=$KATANA_HOME/path/to/Katana:${KTOA_ROOT}/bin:$PATH
export KATANA_RESOURCES=$USER/KtoA-1.1.3-linux${KTOA_ROOT}
Warning

Each KtoA version comes pre-qualified for particular Arnold core and Katana versions and comes bundled with a particular Arnold core version. Please see the release notes for each KtoA version for compatibility.

Setting Environment Variables

After Note that on Windows, KtoA comes with an example script to launch Katana with KtoA: launchScript.bat.  You can readily customize that script rather than set your own environment variables.

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

  • ARNOLDTREE is 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 should instead symlink the path from your Arnold installation to /usr/local/arnold

  • KATANA_HOME is the path to your Katana installation root.
  • PATH should KTOA_ROOT is a convenience for setting the other environment variables; neither KtoA nor Katana make direct use of it.
  • PATH could be modified to include at least the Arnold bin directory, which is in $ARNOLDTREE/bin, and KtoA bin 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 Arnold/Katana KtoA renderer resources; this is $KATANA_HOME/plugins/Resources/Arnold4.0.

...

  • is simply the path to the KtoA installation directory.

On Linux, if you are using a bash shell, you may create a script before running katana. The contents of this file would look like this (modify your paths accordingly):

Code Block
languagebash
export foundry_LICENSE=4101@localhost
export solidangle_LICENSE=5053@localhost
export DEFAULT_RENDERER=arnold
export "KATANA_TAGLINE=With crusty old Katana-Arnold"
export ARNOLDTREE=$USER/katana-tests/Arnold-4.2.6.0-linux
export KATANA_HOME=$USER/Katana-2.0v1
export PATH=$ARNOLDTREE/bin:$KATANA_HOME:$PATH
export KATANA_RESOURCES=$KATANA_HOME/plugins/Resources/Arnold4.2

 

Troubleshooting

When rendering in Katana, always check the Render Log Viewer (bottom right) for any errors.

libai.so
Code Block
/work/apps/katana/plugins/Resources/Arnold4.2/RenderBin/arnold_render: error while loading shared libraries: libai.so: cannot open shared object file: No such file or directory

 

If the plugin cannot find libai.so then make sure the LD_LIBRARY_PATH is pointing to the location of your arnold bin (/work/apps/arnold/dist/Arnold-4.2.6.0/bin).

More Environment Variables

There are a few more environment variables of interest:

should consider creating a script to set the main environment variables and launch Katana for you.

More Environment Variables

There are a few more environment variables of interest:

  • KTOA_LOAD_VERBOSITY: how chatty do you want Arnold to be when loading shaders/plugins for e.g. 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 subdirect subdirectory of KtoA
  • (deprecated) ARNOLDTREE: This is not used anymore.  It used to this variablespecify 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

Licensing Environment Variables 

...