HP Scalable Visualization Array Version 1.
© Copyright 2005–2006 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 Intended Audience..................................................................................................................................7 Document Organization...........................................................................................................................7 Typographic Conventions......................................................................
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. Intended Audience Application developers and system administrators.
Related Information Related documentation is available via links from the home page for the SVA Documentation Library. It also includes links to third party documentation available on the Web that is relevant to users of SVA. Publishing History The document printing date and part number indicate the document’s current edition. The printing date will change when a new edition is printed. Minor changes may be made at reprint without changing the printing date.
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 functions and commands.
2 Configuration Data Access Functions, Scripts, and Commands This chapter describes the syntax for the following: • Configuration Data Utility (svaconfigure). • Configuration Data Access functions. • Script Commands. • Data Access Environment Variables. Manpages are installed on all the SVA nodes for all commands and functions.
Configuration Data File Utility This section provides the detailed syntax for the svaconfigure command.
svaconfigure(8) svaconfigure 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.
Functions, Script Commands, and Environment Variables This section provides syntax information on functions, commands, and environment variables used in the job launch scripts. Configuration Data Access Functions This section provides detailed syntax on the Configuration Data Access functions.
svaAllocateJob(3) svaAllocateJob 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.
svaCleanup(3) svaCleanup 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) svaDisplayError 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) svaDisplayDataStatus 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.
svaDisplayVerbose(3) svaDisplayVerbose 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) svaDisplayVersion 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.
svaGetJobDefaults(3) svaGetJobDefaults 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) svaRunDisplayHosts 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) svaRunDisplayXServers 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) svaRunDMXServer 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) svaRunExecutionHost 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) svaRunRenderHosts 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) svaRunRenderXServers 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.
svaValidateOptions(3) svaValidateOptions 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_chromium_dmx.sh(1) sva_chromium_dmx.sh 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 ] [ -i ] [ -v ] [ -V ] [ -D ] [ -h ] { application_command } Parameters -d display-surface or --display-surface name Selects a Display Surface to use for the job. A Display Surface is a named display that consists of one or more display devices with a particular orientation.
You can also use this command in interactive mode to launch non-OpenGL applications, for example, to display high resolution images or other tasks. This is a convenient way to take advantage of the SVA multi-tile display. Once the desktop environment appears in interactive mode, you can create icons to launch an application. Refer to the SVA User's Guide for more information on running a script in interactive mode.
sva_job_template.sh(1) sva_job_template.sh 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 ] [ -v ] [ -V ] [ -h ] Parameters -d display-surface or --display-surface name Select a Display Surface to use for the job. A Display Surface is a named display that consists of one or more display devices with a particular orientation.
sva_paraview.sh(1) sva_paraview.sh sva_paraview.sh -- Launches the ParaView application. Synopsis sva_paraview.sh [ -d display-surface ] [ -r render-count ] [ -p partition-name ] [ -I ] [ -g ] [ -v ] [ -V ] [ -h ] Parameters -d display-surface or --display-surface name Selects a Display Surface to use for the job. A Display Surface is a named display that consists of one or more display devices with a particular orientation.
In addition to starting the session and launching the sample application, the sva_paraview.sh script also terminates X and cleans up the session when the program is done. 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.
sva_remote.sh(1) sva_remote.sh sva_remote.sh -- Runs an application on the SVA that is accessed using HP Remote Graphics Software. Synopsis sva_remote.
Returns None. Description This command launches a fully functional Bash shell script to run an application on a single node in the SVA. It is designed to use HP Remote Graphics Software (RGS) to control the application from a local desktop. The command is on your PATH. The script allocates cluster resources, launches necessary ancillary applications (for example, the X Servers and the RGS Sender), runs the application on the appropriate node, and terminates the application at the end of the session.
% sva_remote.sh -d n22 -I Refer to the SVA User's Guide for a more detailed interactive example.
svagetdata(1) svagetdata 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) svaputdata 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.
Data Access Environment Variables This section 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 Variable Description DISPLAY svainit sets this variable to :0.0. This value changes temporarily when DMX servers start. GCONF_LOCAL_LOCKS svainit sets this variable to 1 to avoid GCONF problems that cause the display node X Server to crash. Do not modify this value. SLURM_JOBID The job ID of the current allocation. SVA_JOBS svainit sets this variable to the location where Job Settings Files are stored. Do not modify this value.
Variable Description SVA_Display_Hosts svaAllocateJob sets this variable to the condensed host names of the display hosts allocated to the job. This value is also stored in the Job Settings File, SVA_JOB section, SVA_DISPLAY_HOSTS tag. Do not modify this value. SVA_Display_Surface This variable is initially set to null. However, if SVA_DISPLAY_SURFACE is specified in the User Configuration File, it is set by svaGetJobDefaults.
Variable Description SVA_XServer This variable is initially set to startx. If DMX is used, it is set to xinit by svaGetJobDefaults. SVA_XServer is used by svaRunDisplayXServers to start the X Servers on the display hosts. SVA_X_Options This variable is initially set to the value of the SVA_X_OPTIONS tag in the SVA_JOB section. It is used to pass extra options to the X Servers when they start.
Index D Discovery process svaconfigure utility, 13 DISPLAY, 41 E Environment variables, 40 used in launch scripts, 9, 14, 40 G GCONF_LOCAL_LOCKS, 41 L Launch scripts environment variables, 14 environment variables for, 40 helper functions, 14 svaconfigure utility, 9, 13 svaDisplayDataStatus, 18 svaDisplayError, 17 svaDisplayVerbose, 19 svaDisplayVersion, 20 svagetdata, 38 svaGetJobDefaults, 21 svaputdata, 39 svaRunDisplayHosts, 22 svaRunDisplayXServers, 23, 25 svaRunDMXServer, 24 svaRunRenderHosts, 26 s
