HP Scalable Visualization Array Version 2.
© Copyright 2006, 2007 Hewlett-Packard Development Company, L.P. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice.
Table of Contents About This Document.........................................................................................................7 1 Intended Audience...............................................................................................................................7 2 Document Organization......................................................................................................................7 3 Typographic Conventions....................................................
svagetdata(1).........................................................................................................................................59 svaputdata(1)........................................................................................................................................60 Index.................................................................................................................................
List of Tables 2-1 Environment Variables for Running Applications........................................................................
About This Document This document describes Visualization System Software utilities and commands used by application developers, including those used for application launch scripts, and the helper functions and environment variables that support the launch scripts and running applications. The document also provides syntax information on the command to generate the Site Configuration Data File. 1 Intended Audience Application developers and system administrators.
| WARNING Separates items in a list of choices. A warning calls attention to important information that if not understood or followed will result in personal injury or nonrecoverable system problems. A caution calls attention to important information that if not understood or followed will result in data loss, data corruption, or damage to hardware or software. This alert provides essential information to explain a concept or to complete a task.
1 Main Areas of the VSS There are several categories of Visualization System Software (VSS) that help you get an application running on an HP Scalable Visualization Array (SVA). In addition, there are job launch scripts and script templates that help you run applications on the SVA. This chapter provides an overview of these utilities, functions, and commands. 1.1 Utilities There are several utilities whose syntax is documented in this book. 1.1.
2 Data Access Environment Variables This chapter documents the Data Access environment variables used in job launch scripts. These variables are defined in the /opt/sva/bin/sva_init.sh initialization file. The Data Access Functions for running an application, interactively or using a launch script, use these variables. You need to execute the . svainit command in any launch script before you use the Data Access Functions to set values for the environment variables.
Table 2-1 Environment Variables for Running Applications (continued) Variable Description SVA_Render_Count This variable is initially set to 0. However, if SVA_RENDER_COUNT is specified in the User Configuration File, it is set by svaGetJobDefaults. It can also be set by the command line argument -r in some scripts; for example, the sva_job_template.sh. Before the job is allocated, the SVA_Render_Count value is used to request rendering resources for a job.
Table 2-1 Environment Variables for Running Applications (continued) Variable Description SVA_Partition_Name This variable is set to the value of SVA_PARTITION and is prefixed with -p. It can also be set by the command line argument -p in some script; for example, sva_job_template.sh. This variable is used on all SLURM command lines to specify the SLURM partition to use for allocating and running jobs.
Utilities This section provides the detailed syntax for utility commands. Manpages are installed on all the SVA nodes for all utilities, commands, and functions.
svaconfigure(8) NAME svaconfigure -- Starts the full cluster discovery process to create the Site Configuration File. Synopsis svaconfigure [-c cluster_name] [ -v ] [ -V ] [ -h ] Parameters -c or --cluster The name of the cluster. Normally the name is derived from the external name of the head node. However, if for any reason the head node does not have an external name, or if you want to use a different cluster identifier, then use this option to specify one.
svacontrolframelock(8) NAME svacontrolframelock -- Enables framelock on a set of nodes. Synopsis svacontrolframelock [--polarity pol ] [--interval int ] [--delay delay ] [--house ] [ ] {display...} svacontrolframelock [--disable ] {display...} svacontrolframelock [ --help ] Parameters --disable --polarity pol --interval int --delay delay --house --help display… Disables framelock on the displays listed.
Configuration Data Access Functions This section provides detailed syntax on the Configuration Data Access functions. Manpages are installed on all the SVA nodes for these functions.
svaAllocateJob(3) NAME svaAllocateJob -- Allocates cluster resources and starts a job. Synopsis svaAllocateJob Parameters This command does not use any formal parameters on the command line. Instead, use the shell environment variables to pass values to the command. Returns If the allocation succeeds, the requested resources are allocated, the SLURM_JOBID variable is set to the job id, and a 0 is returned. Description Allocates resources based on the settings in the following environment variables.
Make sure the job launch script sources the svainit file before this function is called: .
svaCleanup(3) NAME svaCleanup -- Terminates services started for the job. Synopsis svaCleanup Parameters None. Returns If cleanup has already been called, the shell exit function is called. Description Terminates the session and releases the license for other users. Make sure the job launch script sources the svainit file before this function is called: .
svaDisplayError(3) NAME svaDisplayError -- Writes a text message to STDERR. Synopsis svaDisplayError text Parameters text Any text string. Returns None. Description The text is prefixed with ERROR: and written to STDERR. Make sure that the job launch script sources the svainit file before this function is called: .
svaDisplayDataStatus(3) NAME svaDisplayDataStatus -- Writes a text message from svagetdata or svaputdata to STDERR. Synopsis svaDisplayDataStatus error-code Parameters error-code The value returned by svagetdata or svaputdata. Returns None. Description The text message associated with the error-code parameter is extracted from the svadata message file, prefixed with ERROR: error-code, and written to STDERR. Make sure that the job launch script sources the svainit file before this function is called: .
svaDisplayVerbose(3) NAME svaDisplayVerbose -- Writes a text message to STDOUT. Synopsis svaDisplayVerbose text Parameters text Any text string. Returns None. Description Writes text message to STDOUT if the shell environment variable SVA_Verbose_Flag is set to 1. Make sure the job launch script sources the svainit file before this function is called: .
svaDisplayVersion(3) NAME svaDisplayVersion -- Writes the program name and program version to STDOUT. Synopsis svaDisplayVersion Parameters This command does not use any formal parameters on the command line. Instead, the shell environment variables theProgramName and theProgramVersion pass values to the command. Returns None. Description The program name and version from the environment variables theProgramName and theProgramVersion are written to STDOUT.
svaEnableFrameLock(3) NAME svaEnableFrameLock -- Enables framelock on all nodes in the current Display Surface. Synopsis svaEnableFrameLock [display-id] Parameters display-id By default, this function operates on the :0.0 display of every node in the current Display Surface. If your Display Surface uses a different display ID (such as :2.0), you can specify that ID here. All SVA job launch scripts use the :0.0 display ID. Returns None.
svaGetJobDefaults(3) NAME svaGetJobDefaults -- Loads settings from Site and User Configuration Files into job variables. Synopsis svaGetJobDefaults Parameters None. Returns None. Description Use this function before calling svaAllocateJob to get default job settings from the Site and User Configuration Files, if they are specified. Make sure the job launch script sources the svainit file before this function is called: . svainit The following is a list of the environment variables.
svaRunDisplayHosts(3) NAME svaRunDisplayHosts -- Starts a command on the job's allocated display hosts. Synopsis svaRunDisplayHosts [ -nowait ] command-line Parameters -nowait command-line Runs the command in the background on the display hosts. Does not wait for the command to complete before returning. Any command and its parameters. Returns If -nowait has been passed, the job step ID of the particular action is returned and the JOBSTEP environment variable is set to this value.
svaRunDisplayXServers(3) NAME svaRunDisplayXServers -- Starts X servers on the job's allocated display hosts. Synopsis svaRunDisplayXServers [ -nowait ] Parameters -nowait Runs the X Servers in the background on the display hosts; does not wait for the X Servers to complete before returning. Returns None. Description Runs an X Server on all display hosts allocated to the job. It waits for the command to complete before returning, unless the -nowait option is specified.
svaRunDMXServer(3) NAME svaRunDMXServer -- Starts the DMX Server if one was requested. Synopsis svaRunDMXServer { display input-server } [ -startdesktop ] Parameters display The display where applications can connect to the DMX server. For example, :1 input-server Where DMX takes input. For example, outsidecluster.hp.com:0.0 -startdesktop If this option added to the command line, DMX starts a desktop, and does not return until the desktop exits.
svaRunExecutionHost(3) NAME svaRunExecutionHost -- Starts a command on the job's execution host. Synopsis svaRunExecutionHost [ -nowait ] command-line Parameters -nowait command-line Runs the command in the background on the execution host. Does not wait for the command to complete before returning. Any command and its parameters. Returns If -nowait has been passed, the job step ID of the particular action is returned and the JOBSTEP environment variable is set to this value.
svaRunRenderHosts(3) NAME svaRunRenderHosts -- Starts a command on the job's allocated render hosts. Synopsis svaRunRenderHosts [ -nowait ] command-line Parameters -nowait command-line Runs the command in the background on the render hosts. Does not wait for the command to complete before returning. Any command and its parameters. Returns If -nowait has been passed, the job step ID of the particular action is returned and the JOBSTEP environment variable is set to this value.
svaRunRenderXServers(3) NAME svaRunRenderXServers -- Starts X Servers on the job's allocated render hosts. Synopsis svaRunRenderXServers [ -nowait ] Parameters -nowait Runs the X Servers in the background on the render hosts. Does not wait for the command to complete before returning. Returns None. Description Runs an X Server on all render hosts allocated to the job. Waits for the command to complete before returning, unless the -nowait option is specified.
svaTerminateJobStep(3) NAME svaTerminateJobStep -- Terminates a whole job, a particular job step, or a process. Synopsis svaTerminateJobStep { -p pid } svaTerminateJobStep { job-step } Parameters -p pid job-step The process ID of a particular process to be terminated. The ID of the job or job step to be cancelled (terminated). The job step may be a simple whole number, indicating that an entire job should be cancelled. It also may be of the form JOB.
svaValidateOptions(3) NAME svaValidateOptions -- Checks the settings of shell environment variables before calling svaAllocateJob. Synopsis svaValidateOptions Parameters None. Returns None. Description This function checks for proper settings in the following shell variables: SVA_Display_Surface SVA_Compute_Count SVA_Render_Count If any of these variables are not set properly, the environment variable SVA_Usage_Error is set to 1.
Script Commands This section contains information on the options for job launch scripts, and on commands you can use in the scripts.
sva_amiravr.sh(1) NAME sva_amiravr.sh -- Runs Amira as a VR application. Synopsis sva_amiravr.sh [ -d display-surface ] [ --config amira_configuration_file ] [ -p partition-name ] [ -g resolution ] [ -f ] [ -s ] [ -v ] [ -V ] [ -D ] [ -h ] [ application_command_parameters ] Parameters -d display-surface or --display_surface name Selects a Display Surface to use for the job. It also implicitly selects the execution host for the job because each Display Surface has a default execution host.
For Display Surfaces created and defined as stereo-capable with the Display Surface Configuration tool, this option causes the Display Surface's stereo capabilities to be used on this job. Without this option, the same Display Surface would use only its mono capabilities. Provides additional debugging feedback to the screen as -v or --verbose the script runs. Displays the version of this script. -V or --version Displays Help for the script.
sva_chromium_dmx.sh(1) NAME sva_chromium_dmx.sh -- Allocates, launches, runs, and terminates a Chromium job. Synopsis sva_chromium_dmx.sh { -d display-surface } [ -p partition-name ] [ -I ] [ -g resolution ] [ -i input-x-display] [ -s ] [ -l ] [ -e ] [ -f ] [ -v ] [ -V ] [ -D ] [ -h ] { application_command } Parameters -d display-surface or --display_surface name Selects a Display Surface to use for the job.
for the Display Surface itself in the Display Surface declaration section of the Site Configuration File, or for the entire cluster by means of the SVA_CLUSTER section of Site Configuration File. -i input-x-display or --input input-x-display -s or --stereo -l or --local Sets the particular display within the specified Display Surface that DMX will use for input. If this is used, the DMX console is not used. Values take the form: node:0.0.
This command launches your application by requesting and allocating visualization nodes to the job. The display takes place on the Display Surface you specify as an option, and which is specific to your cluster. The launch script takes care of running the various Chromium portions (Mothership and Servers) on the display nodes. Where the master application and DMX run is based on the SVA_EXECUTION_HOST value for the Display Surface, as specified in the Configuration Data Files.
sva_ensight82.sh (1) NAME sva_ensight82.sh -- Launches the EnSight application. Synopsis sva_ensight82.sh [ -d display-surface ] [ -r nodecount-per-pipeline] [ -p partition-name ] [ -g resolution] [ -s ] [ -f ] [ -v ] [ -V ] [ -h ] Parameters -d display-surface or --display_surface name Selects a Display Surface to use in VR mode. The execution host is always the node where the script is launched. There is no default display, which means the resulting image appear in the EnSight display window.
-f or --framelock Enables hardware framelock on any Display Surface for jobs. Requires an NVIDIA framelock-capable graphics card and the NVIDIA Quadro G-Sync option card installed. -v or --verbose -V or --version -h or --help Provides additional debugging feedback to the screen as the script runs. Displays the version of this script. Displays Help for the script. Returns None. Description This command launches a Bash shell job script to run the distributed EnSight application.
See the sva_vgltvnc.sh manpage and the SVA Users Guide for information on how to use the EnSight script remotely via TurboVNC.
sva_job_template.sh(1) NAME sva_job_template.sh -- Allocates, launches, runs, and terminates visualization jobs. Synopsis sva_job_template.sh { -d display-surface } [ -r render-count ] [ -c compute-count ] [ -p partition-name ] [ -g ] [ -s ] [ -l ] [ -f ] [ -v ] [ -V ] [ -h ] Parameters -d display-surface or --display_surface name Select a Display Surface to use for the job. It also implicitly selects the execution host for the job because each Display Surface has a default execution host.
-l or --local Use the local X display (the current X desktop) for display instead of a Display Surface. Use this as an alternative to --display_surface. The application runs on the job's execution host (SVA_EXECUTION_HOST, a Site Configuration File tag) -f or --framelock Enables hardware framelock on any Display Surface for interactive or non-interactive jobs. Requires an NVIDIA framelock-capable graphics card and the NVIDIA Quadro G-Sync option card to be installed.
sva_paraview.sh(1) NAME sva_paraview.sh -- Launches the ParaView application. Synopsis sva_paraview.sh [ -d display-surface ] [ -r render-count ] [ -p partition-name ] [ -I ] [ -g ] [ -s ] [ -l ] [ -f ] [ -v ] [ -V ] [ -h ] Parameters -d display-surface or --display_surface name Selects a Display Surface to use for the job. It also implicitly selects the execution host for the job because each Display Surface has a default execution host.
-l or --local -f or --framelock on this job. Without this option, the same Display Surface would use only its mono capabilities. Use the local X display (the current X desktop) as part of the SVA job. The Paraview GUI is displayed there, rather than on a Display Surface. If you use this option in addition to --display_surface, then the Paraview GUI displays on the local display and Paraview uses the Display Surface for its 3D graphics data display.
Important: This series of steps is needed because of the way ssh and MPI interact. Before using the sva_paraview.sh script for the first time, you must ssh to the all the nodes in the cluster, or the script fails. When you access each node with ssh, you must do so twice by using each of the two names used by the nodes for each network. That is, the Administration network uses the base node name, for example, viz6; the System Interconnect uses the base node name with the ic- prefix, for example, ic-viz6.
sva_remote.sh(1) NAME sva_remote.sh -- Runs an application on the SVA that is accessed using HP Remote Graphics Software. Synopsis sva_remote.sh [ -d display-surface ] [ -R ] [ -p partition-name ] [ -I ] [ -g ] [ -v ] [ -V ] [ -D ] [ -u ] [ -h ] { application_command } Parameters -d display-surface or --display_surface name Selects a Display Surface to use for the job, either by specifying the name of an existing Display Surface or by specifying the name of a visualization node (render or display).
the machine you are logged into. You can then start, stop, and restart applications as usual. To terminate your session, log out from your desktop environment. You must use the script command a second time to launch applications. The second invocation requires only the application pathname be entered as a parameter to the script command. -g or --tile_geometry Sets the tile geometry that each of the tiles uses. Valid values include 1280x1024, 1400x1050, and 1600x1200.
• host node defined for the Display Surface runs your application. The SVA_EXECUTION_HOST value for the Display Surface is specified in the Configuration Data Files. You can determine this value by examining the Site Configuration File /hptc_cluster/sva/etc/sva.conf. You can use the -d option to specify a render or display node by name, rather than a Display Surface. This node is then allocated and also runs your application. The launched application is the result of a site-specific application command.
sva_startx.sh(1) NAME sva_startx.sh -- Allocates a set of nodes and launches X servers on the nodes. Synopsis sva_startx.sh { -w nodelist } [ -g ] [ -v ] [ -V ] [ -h ] Parameters -w nodelist -g or --tile_geometry Selects the nodes to be included in the job. The nodelist is a list of nodes separated by commas. You can use XC-style node ranges, such as n[1-10] or n[1,2,5]. Sets the tile geometry that each of the tiles uses. Valid values include 1280x1024, 1400x1050, and 1600x1200.
sva_vgltvnc.sh(1) NAME sva_vgltvnc.sh -- Runs an application on the SVA that is accessed using TurboVNC. Synopsis sva_vgltvnc.sh [ -d display-surface ] [ -R ] [ -p partition-name ] [ -I ] [ -g ] [ -v ] [ -V ] [ -D ] [ -u ] [ -h ] { application_command } Parameters -d display-surface or --display_surface name Selects a Display Surface to use for the job, either by specifying the name of an existing Display Surface or by specifying the name of a visualization node (render or display).
the machine you are logged into. You can then start, stop, and restart applications as usual. From a terminal window started from the desktop, you must use the vglrun command to launch OpenGL applications, with the application pathname entered as a parameter to the vglrun command. To terminate your session, log out from your desktop environment. -g or --tile_geometry Sets the tile geometry that each of the tiles uses. Valid values include 1280x1024, 1400x1050, and 1600x1200.
Files. You can determine this value by examining the Site Configuration File /hptc_cluster/sva/etc/sva.conf. • You can use the -d option to specify a render or display node by name, rather than a Display Surface. This node is then allocated and also runs your application. Note that the -R and -d options are mutually exclusive. Once you have a terminal window, you can launch X applications as normal. In the case of OpenGL applications, use the vglrun command with a site-specific application path parameter.
You could launch the EnSight application in a similar way; be sure to use the vglrun command as in the previous example: % sva_vgltvnc.sh -I At this point, you connect to an automatically assigned TurboVNC node on the cluster. Once you are logged into the cluster and have the VNC desktop connected, use a command such as the following: % vglrun sva_ensight82.sh -d ds2x1 --sos 1 -r 1 The display window appears on Display Surface ds2x1 and the GUI appear on the local TurboVNC viewer.
svagetdata(1) NAME svagetdata -- Gets the value of a tag from the named section in the SVA Configuration Data Files. Synopsis svagetdata { section_name } { tag_name } Parameters section_name tag_name Name of the data file section where the tag is found. Name of the tag within the specified section for which to get data. Returns -2 The section or tag was not found. Description The svagetdata command is used in the job launch scripts.
svaputdata(1) NAME svaputdata -- Sets the value of a tag in the named section in the Job Settings data file. Synopsis svaputdata { section_name } { tag_name } { new_value } Parameters section_name tag_name new_value Name of the data file section to which to write the tag value. Name of the tag for which to set the value. Text value to which to set the tag. Returns -3 Access denied. An attempt was made to write to a protected section.
Index D Discovery process svaconfigure utility, 16 DISPLAY, 11 E Environment variables, 11 used in launch scripts, 9, 11, 19 F Framelock enabled with svacontrolframelock utility, 9 enabling with svacontrolframelock utility, 17 G GCONF_LOCAL_LOCKS, 11 L Launch scripts environment variables, 19 environment variables for, 11 helper functions, 19 S Scripts used to launch applications, 9 Site Configuration File created with svaconfigure utility, 9 SVA_Allocate_Hosts, 11 sva_amiravr.sh, 38 sva_chromium_dmx.
