Versions Compared

    Key

    • This line was added.
    • This line was removed.
    • Formatting was changed.
    Comment: Published by Scroll Versions from this space and version 7.5-0

    ...

    Step by step instructions for submitting Nuke jobs with Qube!

    ...


    ...

    Panel
    titleStep 1 (First Time Only)

    The Nuke Jobtype comes with the standard install of Qube! and does not require a specific jobtype to be installed 

    InApp Installation:

    Image Removed

    Section
    Column
    width60

    Install the Nuke submission UI:
    Run WranglerView and go to the Install App UI menu item (File -> Install App UI) as shown.

    Choose "Install Nuke (loadOnce) App UI..."

    This requires that Python be installed on any Worker that runs a Nuke job. If Python is not installed, please see Installing Python. If you can't or don't want to install Python, then choose "Install Nuke (cmdline) App UI..." instead.

    Column
    width40

    Image Added

    Panel
    titleStep 2

     

    Section
    Column
    width60

    Once installed you should be able to locate the "Qube!" menu in Nuke

    ...

    InApp Location:

    Image Removed

    File > Render > Qube >

    's "Render" menu.

    Column
    width40

    Image Added 


    Panel
    titleStep 3
    Section
    Column
    width60

    With a script loaded in Nuke you can choose to render the entire script, or just the selected write node(s), as either "Render All...(cmdline)" or "Render All...(loadOnce)" depending on your requirements.

    Info
    titleloadOnce vs cmdline

    What's the difference?

    loadOnce will open a copy (instance) of Nuke on the Worker that picks up the job, and that instance will render frames as assigned by the Supervisor. Since the scene file is only being opened one time, this can be faster to generate the full sequence.

    cmdline will use the command line to open a new instance of the Nuke file for each frame that it renders. Although this can be slower for large scenes, it can also be more flexible in large, complex environments.

    This will present a pre filled submission UI

    ...

    Image Removed 

    ...

    titleStep 4

    ...

    titleTroubleshooting

    If you find you are getting errors here are some useful links for troubleshooting

    Troubleshooting Flowcharts 

    Below Is an expandable view of the "Nuke (loadOnce) Job..." Jobtype Submission UI

    Note

    Not all sections need to be filled in in order to render only the fields marked in red are required

    Please click on the text below the section of interest

     

    Image Removed

    ...

    Image Removed

    Expand
    titlePrimary parameters

    Nuke Version

    Tooltip - Select version numbers and the worker platform to make an educated guess at where the Nuke executable is found on the remote worker.

    Info

    Use the spinners to enter the required version of nuke

    Nuke path

    Tooltip - explicit path to Nuke executable

    Info

    Browse or enter manually the location of Nuke executable on the workers

    Important : Always double check the location of the workers executable. Be aware that if you are submitting cross platform the path will be different.

    load NukeX

    Tooltip - load NukeX

    Info

    placeholder

    script

    Tooltip - nuke script to execute

    Info

    Browse or enter manually the location of the nuke file to be rendered. This is a required field for submission

    Important: Best practise is to ensure the nuke file and all of its dependant files such as textures are on network storage accessible by the workers.

    Image Removed

    Expand
    titleRender Nodes and Script Args

    execute views

    Tooltip - only execute these views (comma-separated list: e.g. 'left,right'

    Info

    list comma seperated views to render. These are named in your nuke script

    execute nodes

    Tooltip - execute only this node

    Info

    Execute on the specified node. These are named in your nuke script

    script args

    Tooltip - All words between the script name and the frame ranges can be used by [argv n] expressions to provide changing arguments to the script. Each must start with a non-digit to avoid confusion with frame ranges.

    Info

    Explanation and example needed

    Image Removed

    Expand
    titleOptional Switches

    anamorphic

    Tooltip - formats default to anamorphic

    Info

    Tick box to override scene anamorphic settings

    cache size

    Tooltip - limit cache memory usage. Size is in bytes, or append k, M, G or T

    Info

    Enter the numeric value to override scene cache size settings

    interactive

    Tooltip - with -x or -t use interactive, not render, license

    Info

    Tick box to override scene interactive settings

    linear transfer

    Tooltip - apply linear transfer to the file read in

    Info

    Tick box to override scene linear transfer settings

    threads

    Tooltip - set threads to n

    Info

    Enter the numeric value to override scene threads settings

    proxy mode

    Tooltip - turn on proxy mode

    Info

    Tick box to override scene proxy mode settings

    quiet

    Tooltip - quiet (do not print stuff)

    Info

    Tick box to override scene quiet settings

    stack size

    Tooltip - sets the minimum stack size for each thread in bytes, this defaults to 16777216 (16MB) the smallest allowed value is 1048576 (1MB)

    Info

    explaination needed

    verbose

    Tooltip - verbosity (print more stuff)

    Info

    Choose the level of detail you would like the logs to provide

    ...

    Image Removed

    ...

    . Ensure sections marked in red have the correct details.

    Click submit

    Image Removed

    For further details on the submission UI look in the right panel

    Tip
    titleUseful Settings

    While not strictly required, the following settings are useful for getting a better result. You will need to turn on "Expert Mode" (check box at the bottom of the submission UI) in order to get access to them.

    • Make sure that the Nuke version and the OS are set correctly for the Worker(s) that will execute the job.
    • Optimize the use of cores. Set the "Slots = Threads" checkbox and then set the "Specific Thread Count" to a value like 8 (assuming you have 8 cores). (If you have Designer licenses, only set the thread count. Do not check "Slots = Threads")
    • By default, Qube! will not retry failed frames. So set the "Retry frame/instance" value to 3 or 5, to get 3 or 5 retries before it gives up. Related to that, the default wait between retries is zero seconds, which is typically not useful. Set the "Retry Work Delay" to a value like 5 or 10 to allow machines time to recover from temporary problems such as network errors.
    • Because the path to the Nuke executable is part of the submission parameters, it is not possible to mix OSs with Nuke jobs - that is, although you can submit from, say, Windows to OS X, you cannot submit to both Windows and OS X at the same time.


    Column
    width40

    Image Added 

     

    Panel
    titleStep 4
    Section
    Column
    width60

    Click "Submit"

    For further details on the submission UI see below.

    Column
    width40

    Image Added

    Job Submission Details

    Note

    Not all sections need to be filled in in order to render only the fields marked in red are required

     

    Include+
    scrollPageId405BE23F014B092BECE9892A21AF14C8
    scrollEditorDisplayTitle_SimpleCMD_QubeJobBasics
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/_SimpleCMD_QubeJobBasics

    Include+
    scrollPageId405BE23F014B092BECCD2DB5359A0FBE
    scrollEditorDisplayTitle_SimpleCMD_QubeFrameRangeNoChunk
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/._SimpleCMD_QubeFrameRangeNoChunk+v6.7-0

    Include+
    scrollPageId405BE23F014B092BECDB9A2A7F86FA3C
    scrollEditorDisplayTitle_SimpleCMD_PreviewFramesSubmission
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/._SimpleCMD_PreviewFramesSubmission+v6.6-3

    Include+
    scrollPageId405BE23F014B092BEDDFC472663E9CC8
    scrollEditorDisplayTitle_SimpleCMD_ParametersNuke
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/_SimpleCMD_ParametersNuke

    Include+
    scrollPageId405BE23F014B092BED058D3406665A24
    scrollEditorDisplayTitle_SimpleCMD_QubeJobTags
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/_SimpleCMD_QubeJobTags

    Include+
    scrollPageId405BE23F014B092BED0EE4246B9B43C9
    scrollEditorDisplayTitle_SimpleCMD_QubeWorkerSelection
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/._SimpleCMD_QubeWorkerSelection+v6.6-3

    Include+
    scrollPageId405BE23F014B092BED21EDF55CD47477
    scrollEditorDisplayTitle_SimpleCmd_AdvancedJobControl
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/._SimpleCmd_AdvancedJobControl+v6.6-3

    Include+
    scrollPageId405BE23F014B092BED2900AF0E13DE30
    scrollEditorDisplayTitle_SimpleCMD_QubeJobEnvironment
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/._SimpleCMD_QubeJobEnvironment+v6.6-3

    Include+
    scrollPageId405BE23F014B092BED529F670C867EB0
    scrollEditorDisplayTitle_SimpleCMD_QubeRunTimeEnv
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/_SimpleCMD_QubeRunTimeEnv

    Section
    Column
    width40%

    Image Added

    Column
    width60%

    Include+
    scrollPageId405BE23F014B092BEDF311795B653BD6
    scrollEditorDisplayTitle_SimpleCmd_jobValidation_noImage
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/_SimpleCmd_jobValidation_noImage

    Include+
    scrollPageId405BE23F014B092BED37493F7556F3F0
    scrollEditorDisplayTitle_SimpleCMD_QubeActions
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/._SimpleCMD_QubeActions+v6.6-3

    Include+
    scrollPageId405BE23F014B092BED3FFA6C6ABA7BCD
    scrollEditorDisplayTitle_SimpleCMD_QubeNotes
    scrollEditorUrlhttp://docs.pipelinefx.com/display/QUBE/._SimpleCMD_QubeNotes+v7.0-0