Skip to content

Using CNode#

CNode is a standalone command line application. It is the headless version of Clarisse and as such it shares many of its command-line arguments and configuration files with Clarisse. For more information please refer to Using Clarisse section.

One of the main usage of CNode is to render images in association with a generic external render controller application to render Clarisse's images on a render farm. CNode also provides an interactive mode (console like interface). The interactive mode allows you to use Clarisse using python commands without its user interface.

Important

There is no separate installation package available for CNode. It is automatically installed with Clarisse. Also please note that CNode doesn't come with a render farm controller. You must use a dedicated 3rd party render farm controller to distribute renders on a render farm.

Usage#

cnode <input_file> [-image <image_path>][-frames_list <start_frame[[:end_frame][%step]]>] [-output <output_file>] [-format <output_file_format>]

Arguments#

Name Description
input_file Path to the Clarisse project or build file to be loaded.

The specified <input_file> can either be a Clarisse BUiLDER build file or a Clarisse iFX project file. Depending on the specified input file type, arguments may or may not apply.

As a general rule, image render arguments exclusively apply to Clarisse project files while process arguement exclusively works with Clarisse build files since you must specify to CNode the execution entry node of the build. For more information refer to Process and Rendering Using the Build Assembly.

Basic Usage#

cnode my.project

In this simplistic example, CNode will load my.project and will automatically render what was setup in the project. It basically renders all images/layers using paths and frame ranges that were specified in the project.

Displaying Help#

cnode -help

CNode will display the command-line help.

Rendering a specified image of a project#

cnode my.project -image project://context/my_image -frames_list 1:100 -output my_folder/my_image -format tga

In this example, CNode will load the project my.project and will only render the image project://context/my_image starting from frame 1 to frame 100 and saving each frame as a TGA image inside my_folder/my_image folder.

Rendering Multiple Images#

cnode my.project -image project://context/my_image1 project://context/my_image2 -image_frames_list 1:100 100:60%5 -output my_folder1/my_image1 my_folder2/my_image2 -format tga exr32

In this example, CNode, will load the project my.project and will render the 2 images project://context/my_image1 and project://context/my_image2.

Here, CNode will output my_image1 from frame 1 to 100 using a frame step of 1:

my_folder1/my_image1.0001.tga
my_folder1/my_image1.0002.tga
...
my_folder1/my_image1.0099.tga
my_folder1/my_image1.0100.tga

And it will output my_image2 from frame 50 to 60 using a frame step of 5:

my_folder2/my_image2.0050.exr
my_folder2/my_image2.0055.exr
my_folder2/my_image2.0060.exr

Tip

A Clarisse project can contain 1 to multiple images, themselves composed of 1 to multiple layers. By default, such as in example 1, and assuming it is already set in the project, you don't have to specify anything to render an animation. However, as soon as you specify an override such as frame range in the command line, you need to explicitly specify each image and/or layer to be rendered. If you need to specify a global rendering frame range, please use -frame_list argument. |

Return Codes#

When CNode ends its execution it returns a Return Code corresponding to a certain message. This information is very useful to identify if a render for example was successful or if an error has occurred.

Return Code Description
0 No error, the task was successful.
1 A fatal error has occurred.
2 A licensing error has occurred. Check your license server configuration.
3 Wrong arguments are passed to the command line. Check the documentation of each argument for more information.
4 The specified project file or render archive was not found.
5 The specified script was not found.
6 An runtime error has occurred when running the specified script.