NReal Tractor

class nr_cue.nr_cue(spoolfile=None, engine=None, spoolhost=None, project=None, queue=None)
batch_process(job_title='Processing', job_argv=[], priority=50, tasks=[], job_service='PixarRender', tasks_service='PixarRender', owner=None)

Generic Tractor submission method to handle simple tractor jobs like a list of process tasks parented under one job root block->Task1,Task2,Task3…etc. if no job_argv (job task command) is provided, the tasks list will be generated directly under the job root without a parent task.

Parameters:
  • job_title –
  • job_argv – job cmd as list [‘cmd’, ‘arg1’, ‘arg2’…etc.]
  • tasks – list of (title, argv list) tuples
  • job_service –
  • tasks_service –
Returns:

job id
checkin(file_paths, dst, project_code, snapshot_code, tactic_server, task_code, copy_cmd=None, job_title=None, service=None, overwrite=False, post_checkin_status=None, owner=None, priority=50)
Parameters:copy_cmd – a copy command in format cmd -any -args -you -want %s(as src) %s(as dst)
example: copy_cmd=’scp -r -v -P 1503’
file_paths=[‘/home/belal/transferFiles/a.ma’, ‘/home/belal/transferFiles/b.ma’] dst=‘172.16.15.100:/nas/seneferu/sandbox/belal’
checkout(file_paths, dst, project_code, ast_name, ast_context, task_code, copy_cmd=None, service=None, note=None, status_triggers=False, owner=None, priority=50)

Creates a tractor file(s) upload job (uploading to remote user who requested the files) The created job will automatically set the status of the task of interest to first to_status it has before being set “Waiting” by the checkout/loadDependencies request when issued from a remote side.

Parameters:
  • note – optional note to be injected after the task status gets set to a ready state
  • copy_cmd – a copy command in format cmd -any -args -you -want %s(as src) %s(as dst)

if copy_cmd is not available as arg, envvar SYNC_CMD will be used, if Null, then the copy_cmd will default to ‘rsync -rtpogvlHs –progress –delete’ :param status_triggers: enables the status triggers in the generated setTaskStatus job task, this is disabled by default since the note given on the same task will send a notification anyway. Note: the setTaskStatus job task is the one that get executed after the transfer complete to revert the task status to its original state before being set as “Waiting” for transfer.

example:

copy_cmd='scp -r -v -P 1503'
file_paths=['/home/belal/transferFiles/a.ma', '/home/belal/transferFiles/b.ma']
dst='172.16.15.100:/nas/seneferu/sandbox/belal'
render_seq_task(recipe, application, start, end, processing_title='Processing', render_cmd=None, render_node=None, service=None)

Returns a list of Tractor author commands that you can later add them as children to a Tractor Job or Task

Parameters:
  • application –
  • start –
  • end –
  • render_node – the render layer or katana render node to be rendered by this command if any is available
  • processing_title – the title for the frame processing (like ‘rendering…’ which translated as ‘rendering… <frameN>’)
Returns:

list of Tractor author commands that you can later add them as children to a Tractor Job or Task
submit_render(project_code, tactic_server, task, version=0, submit_as=None, spoolfile=None, render_type=None, recipe_location='local', farm_location='local', job_title=None, priority=50, service=None, injectionService=None, inject_overwrite=True, owner=None, force_submit=False)

Gets the snapshot of the given task version, and submit a render job based on render layersInfo file found in the snapshot. :param tactic_server a tactic server stub :param inject_overwrite: overwrite files on server, this is ‘On’ by default so when rerendering missing/corrupted frames, then it can be injected and update the corrupted files on the server :param submit_as: defines the status the submitted task should be set to after it’s sent to Tractor, you can configure the system to submit the jobs to Tractor as paused :param render_type: can take values like ‘first_mid_last’, ‘single’ (only first frame) - if not set, all frames will be processed. :param service: tractor service name to be respected by renderfarm blades :param injectionService: optionally, specify different service key for injecting render files to the database Note: remote & local keywords is meant to be in relative to the submitter workstation/server

submit_render_tasks(project_code, tactic_server, recipe_task, renderable_tasks, layersInfo_file=None, version=0, submit_as=None, spoolfile=None, recipe_location='local', farm_location='local', job_title=None, priority=50, service=None, injectionService=None, inject_overwrite=True, owner=None)

Gets the snapshot of the given task version, and submit a render job based on render layersInfo file found in the snapshot. :param tactic_server a tactic server stub :param submit_as: defines the status the submitted task should be set to after it’s sent to Tractor, you can configure the system to submit the jobs to Tractor as paused :param service: tractor service name to be respected by renderfarm blades :param injectionService: optionally, specify different service key for injecting render files to the database Note: remote & local keywords is meant to be in relative to the submitter workstation/server

tactic_task_submit(server, selected_ids, submit_as=None, job_title=None, priority=50, service=None, recipe_location='local', farm_location='local')

This is a tactic “Custom Layout” python script, it’s part of the ‘nreal/submit_to_tractor’ tactic widget