Welcome to RR Python API’s documentation!

Royal Render applications can run python scripts for customization, event handling, and collecting data. The default Python version in RR9 applications is Python 3.9.

A Python executable, rrPythonconsole, is also provided.

Another executable, rrPythonconsole2, uses Python 2.7.

The modules libpyRR39, libpyRR39_datafiles, and libpyRR39_submit, are provided as module libraries and can be used in python interpreters. They are also available for versions 2.7, 3.7 and 3.9 of python. Importing any of them in a python script also makes the module rrJob available.

Example:
>>> from rr_python_utils.load_rrlib import rrLib
>>> help(rrJob)
Help on module rrJob:
rrJob - rrJob is available for all python scripts in RR applications. It is already loaded / imported.
It defines the job classes (e.g. _JobMinInfo, _JobBasic, ... ), enumerations used by jobs settings,...

The module rr_python_utils, located in the folder RR/SDK/External/Python, is the recommended way to import the modules. It selects the right version for your Python interpreter and caches the modules onto your local machine.

Caching the modules locally avoids network issues, crashes, and file locks that would prevent RR from updating the Python libraries.

Indices and tables