Changeset 20286

Show
Ignore:
Timestamp:
06/03/07 11:11:15 (1 year ago)
Author:
patrick
Message:

Document cluster usage versus single multi-pipe machine usage. I'm surprised
that no one ever pointed out that using VR Juggler on a cluster has not been
documented.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • juggler/branches/2.2/modules/vrjuggler/doc/getting.started.guide/getting.started.guide.xml

    r19991 r20286  
    23322332         <title>Running an Application in a VR System</title> 
    23332333 
    2334          <para>Running an application full-scale in a VR system is mor
    2335          complicated than running in simulator mode. The reason for this is 
    2336          that VR systems tend to differ in configuration and in available 
     2334         <para>Running an application full-scale in a VR system tends to b
     2335         more complicated than running in simulator mode. The reason for this 
     2336         is that VR systems tend to differ in configuration and in available 
    23372337         hardware. VR Juggler is flexible enough to handle most any 
    23382338         configuration you throw at it, but those configurations need to be 
    2339          put together first. Examples of configuration files used in VRAC's C4 
    2340          system are provided, and they are used in this documentation. It 
    2341          should be noted, however, that for any particular system, custom 
    2342          configuration files will probably have to be written. The idea behind 
    2343          this section is to provide a basic understanding of what is needed to 
    2344          get started with running in a VR system.</para> 
    2345  
    2346          <para>The example configuration files in the directory 
    2347          <filename>$VJ_BASE_DIR/share/vrjuggler/data/configFiles</filename> 
    2348          modeled after those used for VRAC's C4 system are as follows:</para> 
    2349  
    2350          <itemizedlist> 
    2351             <listitem> 
    2352                <para><filename>C4.closed.jconf</filename> - The single 
    2353                configuration file that includes the other configuration files 
    2354                necessary for loading a VR Juggler application in the C4 in its 
    2355                closed configuration with full tracking and stereoscopic 
    2356                graphics.</para> 
    2357             </listitem> 
    2358  
    2359             <listitem> 
    2360                <para><filename>C4.closed.mono.jconf</filename> - The single 
    2361                configuration file that includes the other configuration files 
    2362                necessary for loading a VR Juggler application in the C4 in its 
    2363                closed configuration with full tracking and monoscopic 
    2364                graphics.</para> 
    2365             </listitem> 
    2366  
    2367             <listitem> 
    2368                <para><filename>C4.base.jconf</filename> - The basic 
    2369                configuration file needed by all applications when run in the 
    2370                C4. It defines commonly used VR Juggler concepts that are 
    2371                beyond the scope of this particular book.</para> 
    2372             </listitem> 
    2373  
    2374             <listitem> 
    2375                <para><filename>C4.displays.closed.jconf</filename> - The basic 
    2376                display configuration file needed to run with all four walls 
    2377                active and rendering stereoscopic graphics. This defines only 
    2378                the four surface displays to be opened. The corners are 
    2379                configured for the closed position of the movable walls.</para> 
    2380             </listitem> 
    2381  
    2382             <listitem> 
    2383                <para><filename>C4.displays.closed.mono.jconf</filename> - The 
    2384                basic display configuration file needed to run with all four 
    2385                walls active and rendering monoscopic graphics. This defines 
    2386                only the four surface displays to be opened. The corners are 
    2387                configured for the closed position of the movable walls.</para> 
    2388             </listitem> 
    2389  
    2390             <listitem> 
    2391                <para><filename>C4.mstar.jconf</filename> - The Ascension 
    2392                MotionStar configuration file that defines which bird provides 
    2393                input for the head and for the wand.</para> 
    2394             </listitem> 
    2395  
    2396             <listitem> 
    2397                <para><filename>C4.rfwand.jconf</filename> - The radio 
    2398                frequency wireless mouse that acts as a wand.</para> 
    2399             </listitem> 
    2400          </itemizedlist> 
    2401  
    2402          <para>Running the application is the same as in simulator mode except 
    2403          that the configuration files given on the command line are different. 
    2404          For example, to run MPApp in the C4 with stereoscopic graphics, the 
    2405          following command would be used:</para> 
    2406  
    2407          <screen>% MPApp C4.closed.jconf</screen> 
    2408  
    2409          <para>On Mac OS X, the following command would be used:</para> 
    2410  
    2411          <screen>% MPApp.app/Contents/MacOS/MPApp C4.closed.jconf</screen> 
     2339         put together first. VR systems can be driven by a single, multi-pipe 
     2340         machine or a cluster of computers communicating over a network. VR 
     2341         Juggler supports both, and the details are captured in the 
     2342         configuration.</para> 
     2343 
     2344         <para>Example configuration files for different VR system 
     2345         configurations come with VR Juggler. An example of using a single 
     2346         multi-pipe computer is shown for VRAC's C4 system when it was driven 
     2347         by a single multi-pipe SGI Onyx computer. For a cluster, there is a 
     2348         configuration file for VRAC's so-called <quote>ptah cluster</quote> 
     2349         that ran Linux. It should be noted, however, that for any particular 
     2350         VR system, custom configuration files will almost certainly have to 
     2351         be written. The idea behind this section is to provide a basic 
     2352         understanding of what is needed to get started with running in a VR 
     2353         system. Configuration topics are addressed in the VR Juggler 
     2354         <emphasis>Configuration Guide</emphasis>.</para> 
     2355 
     2356         <section> 
     2357            <title>Single Machine Configuration</title> 
     2358 
     2359            <para>The example configuration files in the directory 
     2360            <filename>$VJ_BASE_DIR/share/vrjuggler/data/configFiles</filename> 
     2361            modeled after those used for VRAC's Onyx-powered C4 system are as 
     2362            follows:</para> 
     2363 
     2364            <itemizedlist> 
     2365               <listitem> 
     2366                  <para><filename>C4.closed.jconf</filename> - The single 
     2367                  configuration file that includes the other configuration 
     2368                  files necessary for loading a VR Juggler application in the 
     2369                  C4 in its closed configuration with full tracking and 
     2370                  stereoscopic graphics.</para> 
     2371               </listitem> 
     2372 
     2373               <listitem> 
     2374                  <para><filename>C4.closed.mono.jconf</filename> - The single 
     2375                  configuration file that includes the other configuration 
     2376                  files necessary for loading a VR Juggler application in the 
     2377                  C4 in its closed configuration with full tracking and 
     2378                  monoscopic graphics.</para> 
     2379               </listitem> 
     2380 
     2381               <listitem> 
     2382                  <para><filename>C4.base.jconf</filename> - The basic 
     2383                  configuration file needed by all applications when run in 
     2384                  the C4. It defines commonly used VR Juggler concepts that 
     2385                  are beyond the scope of this particular book.</para> 
     2386               </listitem> 
     2387 
     2388               <listitem> 
     2389                  <para><filename>C4.displays.closed.jconf</filename> - The 
     2390                  basic display configuration file needed to run with all four 
     2391                  walls active and rendering stereoscopic graphics. This 
     2392                  defines only the four surface displays to be opened. The 
     2393                  corners are configured for the closed position of the 
     2394                  movable walls.</para> 
     2395               </listitem> 
     2396 
     2397               <listitem> 
     2398                  <para><filename>C4.displays.closed.mono.jconf</filename> - 
     2399                  The basic display configuration file needed to run with all 
     2400                  four walls active and rendering monoscopic graphics. This 
     2401                  defines only the four surface displays to be opened. The 
     2402                  corners are configured for the closed position of the 
     2403                  movable walls.</para> 
     2404               </listitem> 
     2405 
     2406               <listitem> 
     2407                  <para><filename>C4.mstar.jconf</filename> - The Ascension 
     2408                  MotionStar configuration file that defines which bird 
     2409                  provides input for the head and for the wand.</para> 
     2410               </listitem> 
     2411 
     2412               <listitem> 
     2413                  <para><filename>C4.rfwand.jconf</filename> - The radio 
     2414                  frequency wireless mouse that acts as a wand.</para> 
     2415               </listitem> 
     2416            </itemizedlist> 
     2417 
     2418            <para>Running the application is the same as in simulator mode 
     2419            except that the configuration files given on the command line are 
     2420            different. For example, to run MPApp in the C4 with stereoscopic 
     2421            graphics, the following command would be used:</para> 
     2422 
     2423            <screen>% MPApp C4.closed.jconf</screen> 
     2424 
     2425            <para>On Mac OS X, the following command would be used:</para> 
     2426 
     2427            <screen>% MPApp.app/Contents/MacOS/MPApp C4.closed.jconf</screen> 
     2428         </section> 
     2429 
     2430         <section> 
     2431            <title>Cluster Configuration</title> 
     2432 
     2433            <para>Clusters involve multiple machines, and running VR Juggler 
     2434            on a cluster means running the application on every node of that 
     2435            cluster. Every node must load the same configuration whether it is 
     2436            defined in multiple files or in a single file. VR Juggler (more 
     2437            specifically, Gadgeteer) sorts out which parts of the 
     2438            configuration apply to each node<footnote> 
     2439                  <para>The details of how to configure a cluster are beyond 
     2440                  the scope of this document; readers are directed to the VR 
     2441                  Juggler <emphasis>Configuration Guide</emphasis>.</para> 
     2442               </footnote>.</para> 
     2443 
     2444            <para>The way that any given cluster-ready VR Juggler application 
     2445            works is up to the people who created the application. The sample 
     2446            applications that come with VR Juggler all work the same way. 
     2447            Namely, the same application is run on every node with the same 
     2448            set of command line options. Other applications may use varying 
     2449            command line options depending on the role of the node in the 
     2450            cluster, or different applications may be run on each node, again 
     2451            depending on the role of the node.</para> 
     2452 
     2453            <para>For MPApp, the usage on a cluster is the same as what we 
     2454            have shown previously. The only things that change are the 
     2455            configuration files that are loaded and the execution of the 
     2456            <command>MPApp</command> binary on <emphasis>all nodes of the 
     2457            cluster</emphasis>. If we were to use the example configuration 
     2458            <filename>ptah.cluster.jconf</filename>, the usage on all nodes 
     2459            would be as follows:</para> 
     2460 
     2461            <screen>% MPApp ptah.cluster.jconf</screen> 
     2462 
     2463            <para>On Mac OS X, the following command would be used:</para> 
     2464 
     2465            <screen>% MPApp.app/Contents/MacOS/MPApp ptah.cluster.jconf</screen> 
     2466         </section> 
    24122467      </section> 
    24132468   </chapter>