Overview

brahms_utils offers some basic utilities (though you should usually use the BRAHMS Manager, rather than messing around at this level). You can find details of these utilities by typing help brahms_utils at the Matlab prompt.

Interface

See help brahms_utils for usage instructions. The following operations are available.

These operations are likely to be useful at the Matlab prompt.

RunBuildScript
Run the build script in the release folder of the specified class. If only one language is installed, <language> need not be supplied.
OpenDocumentation
Open the documentation page with the specified title. If title is unspecified, the start page is displayed.
PrepareConfigurationReport
Generate a report on your local configuration, for dispatch to the developers. The report is opened in the editor, for manual copy-and-paste into an email.

These operations may be of use in your own code.

GetSystemMLInstallPath
Return the SystemML install path (from the environment variable "SYSTEMML_INSTALL_PATH")
VersionBRAHMS
Return the BRAHMS version as an array.
VersionStringBRAHMS
Returns the BRAHMS version as a string.
ArchBitsBRAHMS
Returns the bit-width of the installed version of BRAHMS.
GetClassNodePath
Return the node path of the component with the specified class, or empty if not installed.
GetClassReleasePath
Return the release path of the component with the specified class and language. If only one language is installed, <language> need not be supplied. If the class is not installed, returns empty. If more than one release is installed, the latest is returned.
GetConfigFilePath
Return the path to the configuration file at the specified level. If the file does not exist, and <ensureExists> is supplied and evaluates true, it will be created. If it cannot be created, an error is raised.

It is recommended that you use the BRAHMS Manager for managing Execution Parameters; if you need to do this programmatically, however, the following operations may be useful.

GetExecutionParameters
Return the current Execution Parameters as a structure. If <level> is specified, only parameters at that level are returned.
SetExecutionParameter
Set an Execution Parameter at specified level.
DeleteExecutionParameter
Delete an Execution Parameter at specified level.
IsConfigurationWriteable
Return whether configuration at specified level is writeable by the current user. Empty string means yes, non-empty string is the reason why not.

Example

M Source Code (against 995)
% get the version of BRAHMS installed ver = brahms_utils('VersionStringBRAHMS'); % set an Execution Parameter brahms_utils SetExecutionParameter user TimeoutComms 5000