Difference between revisions of "Blender"

From UFRC
Jump to navigation Jump to search
m (Text replace - "HPC Center" to "Research Computing")
Line 1: Line 1:
{|align=right
+
[[Category:Software]][[Category:Graphics]]
  |__TOC__
+
{|<!--CONFIGURATION: REQUIRED-->
  |}
+
|{{#vardefine:app|Blender}}
==Description==
+
|{{#vardefine:url|http://www.blender.org/}}
[http://www.blender.org www.blender.org|blender website]
+
<!--CONFIGURATION: OPTIONAL (1=ON)-->
Blender is an integrated suite of tools enabling the creation of a broad range of 3D content with the singular benefits of cross-platform interoperability and an incredibly small download file size. It is the most popular Open Source 3D graphics application in the world, and is one of the most downloaded.
+
|{{#vardefine:exe|}} <!--RUNNING -->
==Usage==
+
|{{#vardefine:conf|}} <!--CONFIGS-->
Remember, the HPC computational resources are not to be used for developing the blend file! The idea is that you get the blend file ready to go, then transfer that blend file to the Research Computing and submit a job to do the rendering. This is where a good portion of the time takes place.
+
|{{#vardefine:pbs|}} <!--PBS SCRIPTS-->
==Command Line Arguments==
+
|{{#vardefine:policy|}} <!--POLICY-->
<pre>
+
|{{#vardefine:testing|}} <!--TESTING/PROFILING-->
Blender 2.44 (sub 0) Build
+
|{{#vardefine:faq|}} <!--FAQ-->
Usage: blender [options ...] [file]
+
|{{#vardefine:citation|}} <!--CITATION-->
 +
|{{#vardefine:installation|}} <!--INSTALLATION-->
 +
|}
 +
<!--BODY-->
 +
<!--Description-->
 +
{{#if: {{#var: url}}|
 +
{{App_Description|app={{#var:app}}|url={{#var:url}}|name={{#var:app}}}}|}}
  
Render options:
+
3D graphics rendering
  -b <file>    Render <file> in background
 
    -S <name>  Set scene <name>
 
    -f <frame>  Render frame <frame> and save it
 
    -s <frame>  Set start to frame <frame> (use with -a)
 
    -e <frame>  Set end to frame (use with -a)<frame>
 
    -o <path>  Set the render path and file name.
 
      Use // at the start of the path to
 
        render relative to the blend file.
 
      Use # in the filename to be replaced with the frame number
 
      eg: blender -b foobar.blend -o //render_# -F PNG -x 1
 
    -F <format> Set the render format, Valid options are..
 
        TGA IRIS HAMX FTYPE JPEG MOVIE IRIZ RAWTGA
 
        AVIRAW AVIJPEG PNG BMP FRAMESERVER
 
    (formats that can be compiled into blender, not available on all systems)
 
        HDR TIFF EXR MPEG AVICODEC QUICKTIME CINEON DPX
 
    -x <bool>  Set option to add the file extension to the end of the file.
 
    -t <threads>        Use amount of <threads> for rendering
 
  
Animation options:
+
<!--Modules-->
  -a <file(s)>  Playback <file(s)>
+
==Required Modules==
    -p <sx> <sy>        Open with lower left corner at <sx>, <sy>
+
[[Modules|modules documentation]]
    -m          Read from disk (Don't buffer)
+
===Serial===
 
+
*{{#var:app}}
Window options:
+
==System Variables==
  -w            Force opening with borders (default)
+
* HPC_{{#uppercase:{{#var:app}}}}_DIR - installation directory
  -W            Force opening without borders
+
<!--Additional-->
  -p <sx> <sy> <w> <h>  Open with lower left corner at <sx>, <sy>
+
{{#if: {{#var: exe}}|==Additional Information==
                        and width and height <w>, <h>
+
DOUBLE_CLICK_TO_WRITE_INSTRUCTIONS_ON_RUNNING_THE_ACTUAL_BINARY
 
+
|}}
Game Engine specific options:
+
<!--Configuration-->
  -g fixedtime          Run on 50 hertz without dropping frames
+
{{#if: {{#var: conf}}|==Configuration==
  -g vertexarrays      Use Vertex Arrays for rendering (usually faster)
+
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.
  -g noaudio            No audio in Game Engine
+
|}}
  -g nomipmap          No Texture Mipmapping
+
<!--PBS scripts-->
  -g linearmipmap      Linear Texture Mipmapping instead of Nearest (default)
+
{{#if: {{#var: pbs}}|==PBS Script Examples==
 
+
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}}
Misc options:
+
<!--Policy-->
  -d            Turn debugging on
+
{{#if: {{#var: policy}}|==Usage Policy==
  -noaudio      Disable audio on systems that support audio
+
WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used)
  -h            Print this help text
+
|}}
  -y            Disable script links, use -Y to find out why its -y
+
<!--Performance-->
  -P <filename> Run the given Python script (filename or Blender Text)
+
{{#if: {{#var: testing}}|==Performance==
  -v            Print Blender version and exit
+
DOUBLE_CLICK_TO_WRITE_PERFORMANCE_TESTING_RESULTS_HERE
</pre>
+
|}}
As a note, all attempts so far to get the -o OUTPUTFILE option to work have been unsuccessful. Please be sure to define the output file location in the blend file itself.
+
<!--Faq-->
 
+
{{#if: {{#var: faq}}|==FAQ==
==PBS Notes==
+
*'''Q:''' **'''A:'''|}}
 
+
<!--Citation-->
Note that you should add your address to the appropriate line in this case. Also note that the walltime has been set to 2 hours. You will have to figure out through trial and error what the most appropriate amount of time for a rendering should be. In this particular example:
+
{{#if: {{#var: citation}}|==Citation==
* Blender will render the first frame of either a static or dynamic animation.
+
If you publish research that uses {{#var:app}} you have to cite it as follows:
* It will use two threads to perform this operation, hence defining that PBS should use two processors on a single node.
+
DOUBLE_CLICK_TO_WRITE_CITATION_HERE
** With preliminary testing, this also does not appear to be working properly. There is a setting within the rendering options in Blender itself that you can set the number of threads to work from. I recommend setting this to four, and defining the ppn above to four as well.
+
|}}
* The output of the frame will be wherever it was defined in the blend file that was originally saved.
+
<!--Installation-->
 
+
{{#if: {{#var: installation}}|==Installation==
Setting the proper path for the output in the blend file is '''critical''', as this is a batch based system and you will have no idea which computational node actually does the processing. Be sure to set the output path to a known location in the global filesystem, like /scratch/ufhpc. The default in linux is to set this to /tmp, which will simply dump the output to that directory on the local computational node, which means you will not get the results.
+
See the [[{{PAGENAME}}_Install]] page for {{#var: app}} installation notes.|}}
 
+
__NOTOC____NOEDITSECTION__
==Build==
 
Support programs needed by Blender for compilation:
 
* [[Freealut]]
 
* [[OpenEXR]]
 
* [[MesaLib]]
 
===Configuration Files===
 
''/apps/blender/blender-<ver>/source/nan-definitions.mk'':
 
<pre>
 
    export NAN_PYTHON ?= /apps/blender
 
    export NAN_OPENAL ?= /apps/blender
 
    export NAN_JPEG ?= /apps/blender
 
    export NAN_PNG ?= /apps/blender
 
    export NAN_FREETYPE ?= /apps/blender
 
    export NAN_SDL ?= $(shell /apps/blender/bin/sdl-config --prefix)
 
    export NAN_SDLLIBS ?= $(shell /apps/blender/bin/sdl-config --libs)
 
    export NAN_SDLCFLAGS ?= $(shell /apps/blender/bin/sdl-config --cflags)
 
</pre>
 
''/apps/blender/blender-<ver>/source/nan_link.mk'':
 
<pre>
 
    LLIBS = -L$(NAN_MESA)/lib -L/usr/X11R6/lib64 -lXmu -lXext -lX11 -lXi
 
    LLIBS += -L/usr/lib64
 
</pre>
 
 
 
===Environment Variables===
 
<pre>
 
PKG_CONFIG_PATH="/apps/blender/lib/pkgconfig/"
 
INCLUDE="/apps/blender/include:/apps/blender/include/OpenEXR"
 
</pre>
 

Revision as of 16:52, 8 August 2014

Description

Blender website  

3D graphics rendering

Required Modules

modules documentation

Serial

  • Blender

System Variables

  • HPC_{{#uppercase:Blender}}_DIR - installation directory