Documentation

This app is for submitting jobs to a render farm. What makes this app different from the publish app are in the user interface and the option to choose the work file.


• Required Information This is the necessary information to submit a job to a render farm.
• Additional Information This is optional information that can be customized in the pre-hook.
• Outputs This is the main outputs, that can be customized in the environment. Configuration of these outputs can be found in the Configuration section of this page.

The required information are filled out in the default hooks, and include: work_file, jobname, start (frame), end (frame). This is where this app differs from the publish app, as you can choose which file to pass on to the post-hook where the default behaviour is to pass on the work file. This allows the artist to utilize the render farm to speed up previewing the renders before publish. As the submitting of the jobs are handle in the post-hook, you can setup hooks for other tasks than rendering such as simulation, encoding or what ever your render farm can handle.

The additional information can be customized per environment. The app is taking any additional data from the pre-hook, and passing it to the UI for the user to confirm/modify. This is as simple as appending a new type and value to the dictionary passed from the pre-hook:

items.append({"type":"newString","value":"newValue"})
items.append({"type":"newBoolean","value":True})
items.append({"type":"newInteger","value":42})

The acceptable data types are: string, boolean and integer.

The post-hook gets passed in a list of dictionaries that each has the required information as well as the additional information. The additional information are passed in as extra entries in the dictionary. In the default hooks you can see an outline of the variables passed in.

Configuration

Example: Please note that the display_group attribute is not currently supported!

tk-multi-renderfarm:
  hook_post_submit: shot_post_submit_tk_maya
  hook_pre_submit: shot_pre_submit_tk_maya
  location: {path: "https://github.com/baitstudio/tk-multi-renderfarm.git",type: git, version: v0.0.4}
  outputs:
  - {description: Sends Ass export and Arnold render to the farm., display_group: Render, display_name: Arnold Render, icon: icons/arnold.png, name: arnold_render, required: false, selected: false, tank_type: Arnold Render}
  - {description: Send Maya render to the farm., display_group: Render, display_name: Maya Render, icon: icons/maya.png, name: maya_render, required: false, selected: false, tank_type: Maya Render}
  - {description: Exports Ass locally and sends Arnold render to the farm., display_group: Render, display_name: ASS Render, icon: icons/ass.png, name: ass_render, required: false, selected: false, tank_type: Arnold Render}