Icon

This is the documentation for an older version of Qube. The latest version of the documentation can be found here: Qube

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

 

 

 

Image Removed

Expand
titleQube Job Basics

Name

Tooltip - Name of the job

Expand
titleNotes

 

Priority

Tooltip -

Expand
titleNotes

Every job in Qube is assigned a numeric priority. Priority 1 is higher than priority 100. This is similar to 1st place, 2nd place, 3rd place, etc. The default priority assigned to a job is 9999.

Instances

Tooltip -

 

Expand
titleNotes

Instances are the amount of time you would like to spawn a session of your application Example:

On a 12 slot(core) machine running Maya if you set

"Instances" to 4

"Reservations" to host.processors=3

Qube would open 4 "Instances" of Maya on the worker simultaneously

if you set

"Instances" to 1

"Reservations" to "host.processors=1+"

Qube would open 1 "Instance" of Maya on the worker

more on Instances & Reservations

Image Removed

Expand
titleQube Frame Range

Range

Tooltip -

Expand
titleNotes

 

rangeOrdering

Tooltip -

Expand
titleChoices

 

Expand
titleNotes

 

Image Removed

Expand
titlePreview Frames Submission

Use Preview Frames

Tooltip -

Expand
titleNotes

 

Frame Numbers

Tooltip -

Expand
titleNotes

 

Preview Priority

Tooltip -

 

Expand
titleNotes

 

Preview Subjobs

Tooltip -

Expand
titleNotes

 

Image Removed

...

titleRender App Auto-Threads & Uses the Entire Worker

Render on all cores

...

Expand
titleNotes

 

Min Free Slots

Tooltip -

Expand
titleNotes

 

Image Removed

...

titleRender App Uses a Specific Number of Threads

Slots = Threads

Tooltip -

Expand
titleNotes

 

Specific Thread Count

Tooltip -

...

titleNotes

...

Below are instructions on your first steps submitting Maya jobs with Qube!

 

Panel
titleStep 1 (First Time Only)

You will need to install the Maya jobtype

Installation:

Maya requires the "Maya jobtype" to be installed 

If you are not familiar with the installation process please see  Installation Guide & Installation Layout

You will need to select "Maya Jobtype" during the installation process 

Image Added

Alternatively:

If you only wish to use the "batch maya jobs" you can install the InApp plugins via the Qube! WranglerView.

Image Added

File > Install App UI > Install Maya App UI

Panel
titleStep 2

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

InApp Location: 

Image Added

File menu > Qube! 

Panel
titleStep 3

With a scene loaded in Maya choose "Submit Render Job..." or "Submit Batch Render..." depending on your requirements

This will present a pre filled submission UI

Image Added

Panel
titleStep 4

Ensure sections marked in red have the correct details

Click submit

Image Added

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

Panel
titleTroubleshooting

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

Troubleshooting Flowcharts 


Below Is an expandable view of the "Maya 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 Added

Excerpt Include
_SimpleCMD_QubeJobBasics
_SimpleCMD_QubeJobBasics
nopaneltrue

Excerpt Include
_SimpleCMD_QubeFrameRangeNoChunk
_SimpleCMD_QubeFrameRangeNoChunk
nopaneltrue

Excerpt Include
_SimpleCMD_PreviewFramesSubmission
_SimpleCMD_PreviewFramesSubmission
nopaneltrue

Excerpt Include
_SimpleCMD_RenderAppAutoThreads
_SimpleCMD_RenderAppAutoThreads
nopaneltrue

Excerpt Include
_SimpleCMD_RenderAppUses
_SimpleCMD_RenderAppUses
nopaneltrue

Image Modified

Expand
titleScene and Directories

Scenefile

Tooltip -

...

Expand
titleNotes

 

Path to Maya scene (required)

Info

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

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

Project dir

Tooltip - Path to Maya project directory

Expand
titleNotes

 

Info

Browse or enter manually the location of the project directory

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

Image Modified

Expand
titleCameras/Layers/Lights

Cameras

Tooltip -

...

Expand
titleChoices

 

Expand
titleNotes

 

List of cameras to render (space-separated)

Info

Choose from pre polutated and or enter manually cameras to override scene settings

Layers

Tooltip -

...

Expand
titleChoices

 

Expand
titleNotes

 

List of layers to render (space-separated)

Info

Choose from pre polutated and or enter manually layers to override scene settings

EnableDefaultLight

Tooltip -Enable Default Light

Expand
titleNotes

 

Info

Choose from drop down to override scene settings


Image Modified

Expand
titleRenderer

Renderer

Tooltip - Renderer Override

Expand
titleChoices

 

Expand
titleNotes

 

Info

Choose from drop down to override scene settings

Render Threads

Tooltip -

...

Expand
titleNotes

 

each subjob should use. Set to -1 to sync with host.processors, 0 to use all cores on the worker

Info

Enter the numeric value to override scene settings

Further explaination needed

Ignore Errors

Tooltip -

...

Expand
titleNotes

 

Ignore Render-time Errors: ignore error messages that are generated during render-time that would otherwise cause frame failure

Info

Tick box to enable ignore errors

Distributed Rendering

Tooltip -

...

Expand
titleChoices

 

Expand
titleNotes

 

Maya Executable

...

Expand
titleNotes

 

Enable Distributed Rendering (mental ray satellite OR V-Ray DR)

Info

Choose from drop down to override scene settings

see also How to use the mental ray Distributed Bucket Render (DBR) or V-Ray Distributed Render (DR) feature with Qube!

Maya Executable

Tooltip - Specify path to the maya executable file (mayabatch.exe for Windows), if you want to override the auto-detected default. (optional)

Info

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

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


Image Modified

Expand
titleImage File Output

Render dir

Tooltip -

...

Expand
titleNotes

 

Path to Maya output render directory

Info

Browse or manually enter the location of the output image file you wish to generate

Important: Best practise is to ensure outputs are written to network storage accessible by the workers

File Name Prefix

Tooltip - Image file name prefix override

...

Info

...

titleNotes

...

 

Explaination needed

Frame/Anim Ext

Tooltip -

Expand
titleChoices

 

Expand
titleNotes

 

Info

Choose from drop down to override scene settings

Frame Padding

Tooltip -

...

Expand
titleNotes

 

Number of digits for frame number, e.g. 4 means name.XXXX.ext

Info

Enter the numeric value to override scene settings

Renumber StartFrame

Tooltip -

...

Expand
titleNotes

 

The starting output image filename extension value.

Info

Enter the numeric value to override scene settings

Renumber ByFrame

Tooltip -

...

Expand
titleNotes

 

The output image filename extension step ('by' or increment) value

Info

Enter the numeric value to override scene settings

File Extension

Tooltip -

...

Expand
titleNotes

 

File extension name override. The string added at the end of the file name

Info

Enter the file extension value to override scene settings


Image Modified

Expand
titleImage Size

Image Width (pixels)

Tooltip - Image width

Expand
titleNotes

 

Info

Enter the numeric value to override scene settings

Image Height (pixels)

Tooltip - Image height

Expand
titleNotes

 

Info

Enter the numeric value to override scene settings

Maintain Aspect Ratio

Tooltip - Maintain Aspect ratio

Expand
titleChoices

 

Expand
titleNotes

 

Info

Select required option from drop down

Maintain Ratio

Tooltip - Maintain ratio

Expand
titleNotes

 

Info

Select required option from drop down

Pixels/Inch

Tooltip -

...

Expand
titleNotes

 

Resolution (Pixels/Inch)

Info

Enter the numeric value to override scene settings

Device Aspect Ratio

Tooltip - Device Aspect Ratio

Expand
titleNotes

 

Info

Enter the numeric value to override scene settings

Pixel Aspect Ratio

Tooltip - Pixel Aspect Ratio

Expand
titleNotes

 

Info

Enter the numeric value to override scene settings


Image Modified

Expand
titleMel Scripts

preRenderMel

Tooltip -

...

Expand
titleNotes

 

The mel string to be executed before a scene is rendered

Info

Enter the script string

postRenderMel

Tooltip -

...

Expand
titleNotes

 

The mel string to be executed after a scene is rendered

Info

Enter the script string

preRenderLayerMel

Tooltip -

...

Expand
titleNotes

 

The mel string to be executed before a render layer is rendered

Info

Enter the script string

postRenderLayerMel

Tooltip -

...

Expand
titleNotes

 

The mel string to be executed after a render layer is rendered

Info

Enter the script string

preRenderFrameMel

Tooltip -

...

Expand
titleNotes

 

The mel string to be executed before a frame is rendered

Info

Enter the script string

postRenderFrameMel

Tooltip -

...

Expand
titleNotes

 

Image Removed

Expand
titleQube Job Tags

Qube Job Tags

Expand
titleNotes

 

Image Removed

...

titleMel Scripts

Hosts

Tooltip -

Expand
titleNotes

 

Groups

Tooltip -

Expand
titleNotes

 

Omit Hosts

Tooltip -

Expand
titleNotes

 

Omit Groups

Tooltip -

Expand
titleNotes

 

Priority Cluster

...

Expand
titleNotes

 

Host Order

...

Expand
titleNotes

 

Requirements

...

Expand
titleChoices

 

Expand
titleNotes

 

Reservations

...

Expand
titleChoices

 

Expand
titleNotes

 

Restrictions

...

Expand
titleNotes

 

Image Removed

Expand
titleQube Advanced Job Control

placeholder 

Image Removed

Expand
titleQube Actions

placeholder 

Image Removed

Expand
titleQube Notes

placeholder 

The mel string to be executed after a frame is rendered

Info

Enter the script string

Excerpt Include
_SimpleCMD_QubeJobTags
_SimpleCMD_QubeJobTags
nopaneltrue

Excerpt Include
_SimpleCMD_QubeWorkerSelection
_SimpleCMD_QubeWorkerSelection
nopaneltrue

Excerpt Include
_SimpleCmd_AdvancedJobControl
_SimpleCmd_AdvancedJobControl
nopaneltrue

Excerpt Include
_SimpleCMD_QubeJobEnvironment
_SimpleCMD_QubeJobEnvironment
nopaneltrue

Excerpt Include
_SimpleCMD_QubeActions
_SimpleCMD_QubeActions
nopaneltrue

Excerpt Include
_simplecmd_qubenotes
_simplecmd_qubenotes
nopaneltrue