Installation and Licensing on Linux

Installation and Licensing on Linux

Before installing RenderMan for Maya, you need to decide whether you need to install the license server software. Licenses can be either node-locked to a specific computer (or a USB device, for portability), or they can be floating, served via the PixarLicenseServer. If you plan to use a license server to distribute licenses to various computers, install the license server first, before installing RenderMan for Maya. Please see the License Server Installation documentation for details.

RenderMan for Maya Installation

To install RenderMan for Maya to the default location (/opt/pixar/RenderManStudio-19.0-mayaversion), in a root shell, navigate (cd) to the directory where the appropriate .rpm file is located and type:

> rpm -i package.rpm

For example, if you are running CentOS 5.2 and Maya2014, the appropriate installation command is:

> rpm -i RenderManStudio-Maya2014-19.0-linuxRHEL5_gcc41icc121.x86_64.rpm

To install the packages to a different location, the /opt prefix of the default path can be replaced. For example, to install to /usr/local/pixar/RenderManStudio-Maya<version>-19.0, from a root shell type:

> rpm -i --prefix /usr/local package.rpm

After installing, you will need to make sure that Maya is pointing to a correct RenderMan_for_Maya.module file (the installer places an empty one in the /etc directory of your RenderMan for Maya installation). We suggest creating a /modules directory in ~/maya/version/, copying the RenderMan_for_Maya.module file to that directory, and editing it there. It should contain the following (assuming the default installation path):

+ RenderMan_for_Maya <RMS version> /opt/pixar/RenderManStudio-<RMS version>-maya<Maya version>

e.g.

+ RenderMan_for_Maya 4.0 /opt/pixar/RenderManStudio-4.0-maya2013

Alternatively, you can put the file in a non-standard location and set an environment variable (see below). You can run getenv MAYA_MODULE_PATH in Maya's Script Editor to see the standard locations that Maya checks for modules.

You will also need to create symlinks in Maya's /rendererDesc directory (typically in $MAYA_LOCATION/bin/) for the ribRenderer.xml and rmanRenderer.xml files. These files are located in $RMSTREE/etc.

Uninstalling

Uninstalling is a matter of running the same commands listed above, with the -e flag taking the place of the -i flag.


Environment Variables

As long as RMS can find your RenderMan_for_Maya.module file you should not need to set any environment variables. If you install in the default location all is well; if you install in a different location you can point Maya at the .module file with the MAYA_MODULE_PATH variable.

That said, there is one exception to this: the default installation of RMS does not require that you set a RMANTREE variable. However, if you also have RenderMan Pro Server installed and wish to use it is your "external" renderer, you will need to add the following line to your .cshrc (or other startup) file, or to your Maya.env file:

setenv RMANTREE /opt/pixar/RenderManProServer-<version>

You can, optionally, set up your entire environment manually, though it is not recommended. If you choose to do so, you should add the following lines to your startup file, in addition to any variables that Autodesk asks you to set for Maya:

setenv RMSTREE /opt/pixar/RenderManStudio-4.0-maya<version>
setenv MAYA_PLUG_IN_PATH  $RMSTREE/plug-ins
setenv MAYA_SCRIPT_PATH $RMSTREE/scripts
setenv XBMLANGPATH "$RMSTREE/icons/%B"

In this scenario, if you do not have a PYTHONPATH set, you should also set that, to $RMSTREE/scripts:$RMANTREE/bin, and you can also add $RMSTREE/bin (and $RMANTREE/bin) to your path for command line access to the tools.

For more information on setting up your environment, please consult the Environment Variables page.


Optional Installations

Depending on your needs, you may also be using RenderMan Pro Server and/or one of Pixar's queueing products - Tractor or its predecessor, Alfred. Each of these products has a separate installer that you will need to run, and each has different implications for your RenderMan for Maya setup.

RenderMan Pro Server

For complete installation instructions, users should consult the separate RenderMan Pro Server documentation. Basically, the installer takes you through the steps. Once it is installed, users typically employ a queueing system, such as Tractor or Alfred to distribute external renders from RenderMan for Maya. Once Tractor or Alfred is installed, users should be sure to start the necessary components: a tractor-engine and tractor-blade, or the Alfred maitred and alfserver.

Tractor

Tractor has two components, the tractor-engine and the tractor-blade, each with its own installer. The engine should be installed on one system that will serve as a central job queue and task assigner, and the blade should be installed on any system that you intend to spool jobs to, including your local system if you intend to run local external renders. Please consult the RMS/Tractor configuration documentation and the complete (separate) Tractor documentation for complete details.

Alfred

Once you have run the Alfred installer, you will need to set up your maitre-d if you want to distribute mayabatch or spooled RIB renders via Alfred. If you're running your maitre-d on Linux, you can start the maitred via the command line, or as part of an init.d script at boot-time. Please consult the Alfred documentation for complete details.


Licensing

All Pixar applications look for their license information in a pixar.license file that, by default, is located in a shared installation root for all Pixar software (usually $RMANTREE/.. or $RMSTREE/.., e.g. /opt/pixar/pixar.license or /Applications/Pixar/pixar.license). In the case of node-locked software, the pixar.license file is a full-featured license. In the case of "floating" software, this file will contain a "stub" or a "redirector" license, which simply points to the license server and port that will serve the licenses.

The subsections below cover the three most typical scenarios for licensing Pixar software. Choose the scenario that matches your situation and ignore the others, or the wrath of the Licensing Gods will rain down upon your heads...

  • Important

    If you have a floating license you must install the license server on your license server machine and retrieve a license tied to that license server machine first, before retrieving licenses for your other workstations/render nodes.

    Please consult the License Server Installation documentation for instructions on installing the license server.

At the end of the installation process a LicenseApp window will appear and you will need to enter your licensing information (RenderMan support forum user name, password, and your software's serial number). Once you have done so, click the Get License File button; the status window should indicate that a license was retrieved and installed - either a "stub" pixar.license file that points to your license server, or a full, node-locked pixar.license, either of which is downloaded to $RMSTREE/../pixar.license (i.e. /opt/pixar/pixar.license) by default. You may now Quit LicenseApp and the installation will run to completion.

Node-locked Licenses

  • Note

    Node-locked licenses do not require a license server. There is no need to download or install the License Server package.

Floating Licenses - Standard Installation

Floating licenses are keyed to a specific machine designated as your license server. If you have purchased floating licenses, you must download the License Server software from the Downloads section of the RenderMan support forum. Note, this is a separate download from the RenderMan for Maya download. The License Server download package for Linux is PixarLicense-8.0-[Linux Version].rpm.

  • Note

    The Pixar License Server software only needs to be installed on the machine that you have designated as your license server. Additionally, while the seemingly mundane task of serving licenses often falls to older hardware, all of Pixar's RenderMan products, including the license server, require processors that are SSE2 compliant. Also, the license server host and its clients should all be on the same side (inside!) of your site firewall.

Please consult the License Server Installation documentation for instructions on installing the license server.

After the license server has been installed and the site's primary license has been retrieved, the site's serial number is used to retrieve "stub" licenses that automatically point to the site's license server. A stub license should look like this:

<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE PixarLicense SYSTEM "http://renderman.pixar.com/schema/PixarLicense.dtd">
<PixarLicense>
  <LicenseInfo>
    <SerialNumber>123-4567-89098-7654-321012</SerialNumber>
    <Created>01-jan-2011 11:11:11</Created>
    <Licensing>PixarLicense-17.0</Licensing>
    <CustomerInfo>
      <CustomerName>Star Command</CustomerName>
      <ContactName>Buzz Lightyear</ContactName>
      <Phone></Phone>
      <Fax></Fax>
      <Email>blightyear@foo.bar</Email>
    </CustomerInfo>
    <LicensedHost>
    <HostIdentifier>001gg23456f7</HostIdentifier>
      <LicenseAccess type="floating">9010@zurgsbane</LicenseAccess>
    </LicensedHost>
  </LicenseInfo>
</PixarLicense>

At the end of the installation process a LicenseApp window will appear. The LicenseApp application can also retrieve stub licenses. Simply enter the information requested (serial number, forum login and password), and click on Get License to retrieve your stub license.

Note that if you are installing on multiple machines you are not required to use the LicenseApp application on each machine - you can safely copy the stub file to the appropriate location on multiple machines. When LicenseApp launches at the end of the installation process, simply quit the application.

Floating Licenses - Customized Installation

At most sites it is sufficient to simply place the proper pixar.license in the install location, as described above. At larger sites it may be easier to maintain a single license file, rather than installing locally on every machine. In that case, there are two approaches that may be more appropriate:

  1. Recommended - Use the environment variable PIXAR_LICENSE_FILE to point to a pixar.license that is globally accessible.

  2. Alternatively, in a site-wide, custom .ini file, add an appropriate license server entry. Note, this is not suggested because each software package requires this entry in a different .ini or .config file, with different syntax:

    RenderMan for Maya looks in RAT.ini for:

    SetPref LicenseServer    9010@yourlicenseserverhostname
    

    RenderMan Pro Server looks in rendermn.ini for:

    /licenseserver    9010@yourlicenseserverhostname
    

    The Tractor Engine looks in the tractor.config file for:

    "LicenseLocation": "9010@yourlicenseserverhostname"
    

    So, seriously, use Option 1 if you're not using the standard licensing configuration. Please.