The BRAHMS Manager is a Matlab GUI that helps you manage your BRAHMS configuration. To launch it, run
Left Pane (Namespace Manager)
After installing BRAHMS you should add at least one Namespace Root (over and above the default root installed with BRAHMS), which you can then populate with your own Processes. To do this, click on Add under "Configured namespace roots" and choose a directory. This directory can be anywhere in your file space, but its contents should be treated like any documents (that is, you should be backing up this directory - these are not temporary files).
You can add more Roots as you wish - one situation where you might want to do this is if your group shares a Namespace Root, on a remote fileserver, say, and all the members want to use Components from this root, whilst maintaining their own Root locally for their own Components. You can also remove Roots by clicking on Remove - this does not affect the file system, but prevents BRAHMS from searching these folders for Components in future.
Provided you have at least one Root, then the contents (Components) of the selected Root are displayed in the listbox below. You can refresh this list by clicking Refresh, though restarting the Manager achieves the same end. If you accidentally add the wrong folder, and the search is going on and on for ever, you can click Cancel to abort the search.
With an entry (component) in the list selected, you can click on one of the four lower buttons to operate on it. The following operations are available.
Starting a new process
Creating the process
When you click on New, you will be asked which binding you want to develop against. See the notes at Component Bindings to help you choose, if you don't already know.
You will then be asked to choose a SystemML Class Name for your new Process. This is its unique identifier in the Namespace, and is the tag that your users will use to specify your Process. You may, in principle, use any valid SystemML Class Name (alphanumeric, underscore, and forward slashes only, see the SystemML Documentation for full details of the syntax), but there are strongly recommended forms (see Namespace). For publishing, you should use
Finally, you will be asked to confirm the copy operation. When you click OK, the new Process is created, and entered into the list of nodes in the Manager left pane (and selected).
Building and testing the process
If you chose a compiled language (C or C++), you must next build the process. Click on Build to write a build script into the release folder and run it. You can view the results in the Matlab Console window. The build script written is a standard shell script, using
Once built, or for non-native processes (Matlab or Python), click on Test to run the new Process. You can view the results in the Matlab Console window. If the test is successful, you are done with the Manager, and you can now start modifying your new Process as desired. Click on Open to find the associated files. If the test is unsuccessful, you can start by looking up the error code
Right Pane (Parameter Manager)
In this pane you can manage your configuration (Execution Parameters). Mostly, you can just leave these alone, but you can review the reference pages for each parameter type if you want to see what is available.
One parameter you should modify after installation is
|This is a documentation page for the BRAHMS Modular Execution (Simulation) Framework. For details of licensing and distribution, please click here. To advise of an error or omission, please click here.|