Installation and Licensing on Macintosh OS X

Installation and Licensing on Macintosh OS X

Before installing RenderMan Studio, 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 before installing RenderMan Studio.

  • Important

    RenderMan Studio requires X11 on Macintosh OS X. X11 is an "Optional Installation" on the OS X system disk. Users should start X11 before opening any of the RenderMan Studio applications.

RenderMan Studio Installation

Double-click on the RenderMan Studio .pkg file to invoke the installer. The installer will take you through the installation process step-by-step. At the end of the installation process, License.App will start up to retreive your license.

By default, the software is installed in /Applications/Pixar/RenderManStudio-<version>-maya<version>. Maya finds the plugin there via a symlink to the RenderMan_for_Maya.module file. The installer places the symlink in the user's Library/Preferences/Autodesk/maya/<version>/modules directory. If you wish to intall the software in a location other than the default you will need to update that symlink. Additionally, because this is done at the "user" level, different users sharing a machine will need to make sure that Maya can find the .module file. One easy way to do this is via the user's Maya.env file, with the following line:

MAYA_MODULE_PATH=//Applications/Pixar/RenderManStudio-<version>-maya<version>/etc

For more information on setting up your environment, please consult the Environment Variables document in the Configuration section.

  • Important

    The installer no longer writes any "PATH" settings to the Maya.env file. Users who have installed previous versions of RenderMan Studio should delete any existing entries, unless they are using the deprecated MTOR plugin. Note that, when upgrading Maya, if you chose to "copy preferences" from your previous version you may have an older Maya.env file that needs to be edited even if you have not installed RMS for your current version.


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 Studio 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 Studio. 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. 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. /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.

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

Node-locked Licenses

As part of the installation process a licensing application will be invoked. It will ask you for an Entitlement Serial Number, and your Forum login and password. Enter the information in the appropriate fields (if you use a proxy server, your proxy information should be added as host:port, e.g. foo.mydomain.com:8080) and click on the Get License button. The application will contact Pixar's servers and download your license to $RMSTREE/../pixar.license (e.g. /Applications/Pixar/pixar.license). Once it is done, quit the licensing application and the installer will run to completion.

Please note, your initial license will be timed to expire in approximately 30 days. At that time you can run the LicenseApp program again to get your permanent license.

  • 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 and install it before installing RenderMan Studio. Note, this is a separate download from the RenderMan Studio download. The License Server download package for OS X is PixarLicense-11.0-LA-[OS X 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.

After installing the license server, run the installer for RenderMan Studio. As part of the installation process a licensing application will be invoked. It will ask you for an Entitlement Serial Number, and your Forum login and password. Enter the information in the appropriate fields (if you use a proxy server, your proxy information should be added as host:port, e.g. foo.mydomain.com:8080) and click on the Get License button. The application will contact Pixar's servers and download a "stub" (or "redirector") license to $RMSTREE/../pixar.license (e.g. /Applications/Pixar/pixar.license). 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>

Once that is done, quit the licensing application and the installer will run to completion. Note that, if you are installing on multiple machines, you can copy this stub file into the appropriate location on any workstation, as necessary.

Floating Licenses - Customized 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 Studio download. The License Server download package for OS X is PixarLicense-11.0-LA-[OS X 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.

After installing the license server, run the installer for RenderMan Studio. As part of the installation process a licensing application will be invoked. This would install a stub/redirector in the appropriate location. At most sites this is sufficient. 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. First, quit LicenseApp and allow the installer to run to completion. Then, choose one of the following methods:

  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 configuration 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 Studio 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.

Updating a License

Obtaining a new or updated node-locked license is simply a matter of running LicenseApp by double-clicking on it in the /bin subdirectory of your installation. By default, this location is:

/Applications/Pixar/RenderManStudio-<version>-maya<version>/bin

The program will contact Pixar and download your license to the correct location.

The process is the same for a floating license, except you need to run the LicenseApp that is included with the PixarLicense software, located by default in:

/Applications/Pixar/PixarLicense-LA-<version>-<OS X Version>

Stub/redirector files will continue to work without needing any change.


X11 Notes

  • As mentioned above, RenderMan Studio requires X11 on Macintosh OS X. X11 is an "Optional Installation" on the OS X system disk. Users should start X11 before opening any of the RenderMan Studio applications.

  • A known issue with Apple X11.app on OSX Leopard (identified in the About X11 box as 2.1.6 (xorg-server 1.4.2-apple33)) means that some users cannot copy and paste from X11 applications (e.g. Slim and "it") to other applications. Installing the localization updates from xquartz.macosforge.org (X11-Locals-2.3.3.2.pkg) remedies this problem and makes cut and paste much easier to use. Note that this is is for OS X Leopard only, not for OS X Snow Leopard, and it is not a reinstallation of the XQuartz X11.app; it is just a new localized preference file.

    Once you have installed the localization file, the preferences dialog in X11.app will have a Pasteboard tab in which you can turn on "Enable syncing" and the two update options shown below:

    images/x11.png

    Having done this you can, for instance, copy a network in Slim with Control-C and then immediately paste into Mail.app with Command-V.

  • The long-standing bug with the Option (alt) key on a Mac is still present in Apple's X11.app on Leopard. The suggested .Xmodmap modification for this has changed based on our experience with other X11 programs:

    1. In the user's home directory - ~/ - find or create a file named .Xmodmap.
    2. Add the following to said file:
    keycode 66 = Alt_L
    clear Mod1
    add Mod1 = Alt_L Alt_R
    

    If the .Xmodmap exists, the preceding should be appended, and users should confirm that there are no conflicts with the exisiting contents.

    1. Save the file.