Batch Submission

Work in progress

This api is still being built and is subject to change

class BatchSubmission():
    def __init__(self, name):

This is a representation of a Batch Submission.

Attributes

Name	Type	Description
`name`	`str`	The name of the batch submission, as seen in deadline monitor

Properties

Name	Type	Description
`jobs`	`list`	A list of jobs associated with this submission

Methods

`add_maya_render_job()`

Adds a maya render job to this batch

Parameters:

Name	Type	Description
`name`	`str`	The name of job	Mandatory
`scene`	`str`	The name of the maya scene file being used	Mandatory
`software_version`	`int`	The version of Maya being used	Mandatory
`directory`	`str`	The directory to save the output renders	Mandatory
`prefix`	`str`	The pattern used to generate the paths of the rendered outputs.	Mandatory
`padding`	`int`	The frame padding to be used in the output paths	Mandatory
`frame_extension`	`int`	The Maya frame extension to be used in the output paths. The integer value matches the drop down menu found in the maya render settings	Mandatory
`image_format`	`str`	The format of the output render	Mandatory
`frames`	`str`	The frames to be rendered, in a format expected by deadline. Eg ('1001-1100x3')	Mandatory
`layers`	`list`	A list of layer names to be rendered. These must exist within the scene	Mandatory
`aovs`	`list`	A list of aov names to be rendered. These must exist within the scene	Mandatory
`camera`	`list`	A list of cameras to render from. These must exist within the scene	Mandatory
`resolution`	`list`	The width and height of the output render	Mandatory
`include_lights`	`bool`	True if all lights are included in each render layer. Matches setting found in Mayas Render Setup	Mandatory
`pool`	`str`	The name of the deadline pool to submit the job too	Mandatory
`priority`	`int`	Higher numbers will render first. Range of 0-99. Defaults to 50.	Optional
`comment`	`str`	A helpful tag to identify the job. Defaults to ""	Optional
`chunk_size`	`int`	The number of frames per task. Defaults to 1	Optional
`job_dependencies`	`list`	A list of Jobs either represented by a Job object or a uuid. Defaults to None	Optional
`tiles`	`list`	The amount of tiles formatted [X, Y]	Optional
`region`	`bool`	A specified region to render. Formatted as (left, top, right, bottom). Defaults to None	Optional
`optimised_frames`	`bool`	True results in first, last, and middle frames being rendered first. Default True	Optional

Returns:

Name	Type	Description
`job`	`MayaRenderJob`	A job object

`add_maya_script_job()`

Adds a maya script job to this batch

Parameters:

Name	Type	Description	Default
`name`	`str`	The name of job	Mandatory
`scene`	`str`	The name of the maya scene file being used	Mandatory
`software_version`	`int`	The version of Maya being used	Mandatory
`script`	`str`	The path to the script to be executed	Mandatory
`pool`	`str`	The name of the deadline pool to submit the job too	Mandatory
`priority`	`int`	Higher numbers will render first. Range of 0-99. Defaults to 50.	Optional
`comment`	`str`	A helpful tag to identify the job. Defaults to ""	Optional
`chunk_size`	`int`	The number of frames per task. Defaults to 1	Optional
`job_dependencies`	`list`	A list of Jobs either represented by a Job object or a uuid. Defaults to None	Optional
`function`	`str`	The name of the function to be executed. Defaults to None	Optional
`arguments`	`list` or `dict`	The arguments required. Can be provided as either positional arguments, or key word arguments	Optional
`outputs`	`list`	A list of files that will be the output of this script	Optional

Returns:

Name	Type	Description
`job`	`MayaScriptJob`	A job object

`add_harmony_render_job()`

Adds a harmony render job to this batch

Parameters:

Name	Type	Description
`name`	`str`	The name of job	Mandatory
`software_version`	`int`	The version of Maya being used	Mandatory
`environment`	`str`	The harmony environment that contains the project to render	Mandatory
`job`	`str`	The harmony job that contains the project to render	Mandatory
`scene`	`str`	The harmony scene that contains the project to render	Mandatory
`version`	`int`	The harmony version of the project to render	Mandatory
`nodes`	`list`	A dict of write nodes to be rendered. This can contain the following keys: 'path', 'padding', 'format', 'start'	Mandatory
`frames`	`str`	The frames to be rendered, in a format expected by deadline. Eg ('1001-1100x3')	Mandatory
`pool`	`str`	The name of the deadline pool to submit the job too	Mandatory
`priority`	`int`	Higher numbers will render first. Range of 0-99. Defaults to 50.	Optional
`comment`	`str`	A helpful tag to identify the job. Defaults to ""	Optional
`chunk_size`	`int`	The number of frames per task. Defaults to 1	Optional
`job_dependencies`	`list`	A list of Jobs either represented by a Job object or a uuid. Defaults to None	Optional
`resolution`	`list`	The width and height of the output render	Optional
`camera`	`str`	The camera to render with	Optional
`field_of_view`	`int`	The field of view to render with	Optional

Returns:

Name	Type	Description
`job`	`HarmonyRenderJob`	A job object

`add_after_effects_render_job()`

Adds an after effects render job to this batch

Parameters:

Name	Type	Description
`name`	`str`	The name of job	Mandatory
`scene`	`str`	The path to the scene file	Mandatory
`software_version`	`float`	The version of After Effects being used	Mandatory
`comp`	`str`	The comp you wish to render	Mandatory
`frames`	`str`	The frames to be rendered, in a format expected by deadline. Eg ('1001-1100x3')	Mandatory
`pool`	`str`	The name of the deadline pool to submit the job too	Mandatory
`priority`	`int`	Higher numbers will render first. Range of 0-99. Defaults to 50.	Optional
`comment`	`str`	A helpful tag to identify the job. Defaults to ""	Optional
`chunk_size`	`int`	The number of frames per task. Defaults to 1	Optional
`job_dependencies`	`list`	A list of Jobs either represented by a Job object or a uuid. Defaults to None	Optional
`render_template`	`str`	The name of the render template to be used	Optional
`output_template`	`str`	The path of the output template to be used	Optional
`render_settings`	`dict`	Individual render settings e.g	Optional
`output_settings`	`dict`	Individual output settings e.g	Optional
`optimised_frames`	`bool`	True results in first, last, and middle frames being rendered first. Default True	Optional

Returns:

Name	Type	Description
`job`	`AfterEffectsJob`	A job object

`add_ffmpeg_job()`

Adds an ffmpeg job to this batch

Parameters:

Returns:

Name	Type	Description
`job`	`FFMPEGJob`	A job object

`add_python_job()`

Adds a python job to this batch

Parameters:

Name	Type	Description
`name`	`str`	The name of job	Mandatory
`script`	`str`	The path to the script to be executed	Mandatory
`function`	`str`	The name of the function to be executed. Defaults to None	Optional
`arguments`	`list` or `dict`	The arguments required. Can be provided as either positional arguments, or key word arguments	Optional
`outputs`	`list`	A list of output paths that can be accessed through deadline monitor	Optional
`pool`	`str`	The name of the deadline pool to submit the job too	Mandatory
`priority`	`int`	Higher numbers will render first. Range of 0-99. Defaults to 50.	Optional
`comment`	`str`	A helpful tag to identify the job. Defaults to ""	Optional
`chunk_size`	`int`	The number of frames per task. Defaults to 1	Optional
`job_dependencies`	`list`	A list of Jobs either represented by a Job object or a uuid. Defaults to None	Optional

Returns:

Name	Type	Description
`job`	`PythonJob`	A job object

`submit()`

Submits all the jobs that are part of this submission. If some jobs are dependent on each other, the submissions without dependencies will be submitted first.

Returns:

Name	Type	Description
`deadline_uuids`	`list`	A list of deadline Job IDs representing the submitted jobs