Clarisse iFX

Job Submission

You can submit jobs from within Clarisse iFX by installing the integrated submission script, or you can submit them from the Monitor. The instructions for installing the integrated submission script can be found further down this page.

To submit from within Clarisse iFX, click on the custom toolbar item you created during the integrated submission script setup. You will first be prompted to specify a file to export the render archive to.

../_images/clarisse_render_archive.png

After you specify the render archive file, the submitter will come up with the Render Archive and Frame List fields already populated.

../_images/sub_clarisse.png

Note that if you are submitting from the Monitor, you will have to manually export your render archive from inside Clarisse iFX, and then browse to the Render Archive file in the Monitor submitter.

Submission Options

The general Deadline options are explained in the Job Submission documentation. The Clarisse iFX specific options are:

  • Threads: The number of threads to use for rendering. If set to 0, the value in the Clarisse configuration file will be used.
  • Verbose Logging: Enables verbose logging during rendering.

Plug-in Configuration

You can configure the Clarisse iFX plug-in settings from the Monitor. While in super user mode, select Tools -> Configure Plugins and select the Clarisse plug-in from the list on the left.

../_images/cp_clarisse.png

Render Executables

  • CRender Executable: The path to the Clarisse’s crender executable file used for rendering. Enter alternative paths on separate lines.

Configuration Options

  • Global Config File: A global configuration file to be used for rendering. If left blank, the Clarisse.cfg file in the user home directory will be used instead.
  • Module Paths: Additional paths to search for modules (one path per line).
  • Search Paths: Additional paths to search for includes (one path per line).

Integrated Submission Script Setup

The following procedures describe how to install the integrated Clarisse iFX submission script. This script allows for submitting Clarisse iFX render jobs to Deadline directly from within the Clarisse iFX editing GUI.

You can either run the Submitter installer or manually install the submission script

Submitter Installer

Manual Installation of the Submission Script

  • In Clarisse iFX, right-click on the toolbar at the top and select Add Item.

    ../_images/clarisse_integrated_step_1.png
  • In the Add New Item dialog, set the following properties:
    • Title: Submit To Deadline
    • Category: Custom
    • Category Custom: Deadline
    • Script Path: Choose the DeadlineClarisseClient.py script from [Repository]\submission\Clarisse\Client
    ../_images/clarisse_integrated_step_2.png
  • Click Add, and you should now see a Deadline tab in the toolbar with a button that you can click on to submit the job.

    ../_images/clarisse_integrated_step_3.png

FAQ

Which versions of Clarisse iFX are supported?

The “crender” application is used for rendering, so any version of Clarisse iFX that includes this application is supported.

Error Messages and Meanings

This is a collection of known Clarisse iFX error messages and their meanings, as well as possible solutions. We want to keep this list as up to date as possible, so if you run into an error message that isn’t listed here, please email Deadline Support and let us know.

Currently, no error messages have been reported for this plug-in.