Using The Combustion Submit Script

*** Beta Test: 06/01/2005-06/30/2005 ***
Please send bug reports to

Index


Installing the Combustion Submit Script

    Before using the Combustion script, you should first install it by making a copy of the script on your file server, so that this copy is accessible by all the machines on your network. This is usually done by your sysadmin, or the person who set up the rush software.

  1. Install the script on the file server.
  2. This should have already been set up by your sysadmin, or the person who installed the rush software:

  3. Modify the script to set up Combustion for your environment.
  4. This script will be executed not only by the user to bring up the submit-combustion GUI, but it will also be executed on all the render machines to run the renders.

    To ensure the renders run with the proper environment, you'll need to modify these lines at the top of the script:

    ### COMBUSTION SPECIFIC VARIABLES -- CUSTOMIZE AS NECESSARY ###
    ### See Discreet's documentation for more info.             ###
    if ( $G::iswindows )
    {
        # WINDOWS
        $ENV{PATH} = "c:/program files/discreet/combustion 4;$ENV{PATH}";
    }
    elsif ( -d "/Applications" )
    {
        # OSX
        $ENV{PATH} = "/Applications/Discreet/Combustion/bin:$ENV{PATH}";
    }
    else
    {
        # LINUX
        $ENV{PATH} = "/usr/discreet/combustion/bin:$ENV{PATH}";
    }
    

  5. Make a desktop shortcut to the submit script.
  6. Be sure the shortcut points to a copy on a file server, and not to local files in c:\rush\examples (windows) or /usr/local/rush/examples (unix).

  7. Invoke the submit script.
  8. Should be as simple as clicking on your desktop shortcut.

    If you prefer using a terminal window, be sure to run the script with an absolute UNC path, eg:

    	    perl //server/jobs/rushscripts/perl/submit-combustion.pl
    	    
    If you don't run it with an absolute path, the frames will fail because rush didn't have the absolute path to the submit script.

  9. Verify the interface comes up.
  10. The interface should pop up. If it doesn't, verify (unix) the first line in the script's path points to the correct location of your perl binary, or (windows) the '.pl' extension is configured to correctly invoke perl.

    Click the help button (buttons with '?') for any field you want to know more about.

    When the GUI pops up, note there are various 'Advanced Options' available if you scroll the window down.


Using Submit Combustion

    It is assumed you are able to bring up the submit script from a desktop shortcut (which you can make by following these instructions for Mac OSX, Windows, or Linux)

  1. Enter the full path to the .cws file.
  2. For the Worksspace Path, navigate to your .cws file using the Browse button. If it is your first time submitting, you may have to manually type in the //server/volume name in order to get a directory listing.

    Avoid using a mapped drive letter (z:/yada/yada) to get to your cws file to avoid problems with drive maps, eg. when people log out, and the drive maps disappear.

  3. The 'Output Path'.
  4. Set the Output Path to the directory where you want the images to be written to. Include the filename followed by a dot (.), as this is the syntax Combustion wants you to use.

    So for instance, if you specify:

    	    //server/jobs/honda/images/sc17-bg.
    	    
    ..and have the "Image Format" set to 'cineon', this will result in files being rendered as:
    	    //server/jobs/honda/images/sc17-bg.0001.cin
    	    //server/jobs/honda/images/sc17-bg.0002.cin
    	    ..
    	    

  5. Set the 'Image Format'.
  6. This is the image format for the rendered images.

  7. Enter the frame range to render.
  8. This is the range of frames you want to render; normally two values separated by a dash, eg. '1-100'.

    You can also specify individual frames, multiple ranges, or cobinations of both, eg. '1 10 20-30 400-900', which would render frames 1, 10, 20 through 30, and 400 through 900.

  9. Enter the cpus to use.
  10. In our case, lets use any 5 available cpus at the lowest priority:

      
    	    +any=5@1
    	    

  11. Advanced Options.
  12. Scroll down to look over the 'Advanced Options'. For instance the 'Combustion Flags' prompt lets you pass extra command line arguments to Combustion's 'shellrenderer' command line; see 'shellrenderer -help' for more info.

    Also, various other seldom changed flags, such as Field Dominance, and other options are available.

    Click the help button (buttons with '?') for any field you want to know more about.

  13. Hit 'Submit'.
  14. This should submit your job, and a window indicating the jobid should pop up, followed by an irush interface with the jobid already set to the new job.

    The next time you bring up the submit form, it will have all the values set from the last execution. Note that you can then save this as a form so you can easily recall it later.

    For more info on the irush interface, see the irush tutorial.

  15. Monitor the job.
  16. Hit 'Frames' in irush to watch the progress of your job.
    If some frames are running, or got done already, click on some, and hit 'Logs' to see the output of the perl commands you entered.

  17. Dump the job when you're done.
  18. When you're finished with the job, hit 'Dump' in irush.