Install BRAHMS in Matlab

You need to add the folder below to your Matlab path. If you use the Matlab pathtool (or File menu, "Set Path"), then go ahead and use that to add it. If you prefer, you can use the addpath command; put this in your startup.m file to stay connected to BRAHMS when you restart Matlab.


I use this snippet in my startup.m file to easily set the Matlab path based on SYSTEMML_INSTALL_PATH.

Matlab Console
path = getenv('SYSTEMML_INSTALL_PATH'); addpath([path '/BRAHMS/bindings/invocation/995']);


Open Matlab and enter brahms. If BRAHMS is correctly installed, the output should look something like this:

Matlab Console
BRAHMS Version ... Copyright (C) 2007-2011 Ben Mitchinson BRAHMS comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under certain conditions. For details, type "brahms --license", and/or visit us at Usage: brahms <exefile> [<option> ...] brahms <operation> [<option> ...] ...

Try sml_utils. If the SystemML Toolbox is correctly installed, the output should look something like this:

Matlab Console
SystemML Toolbox Version is installed

If that does not work...
  • Check that path has been set correctly (enter path at the Matlab prompt). It must include the paths detailed above.
  • Restart Matlab.
  • Restart your machine.

Set WorkingDirectory

Start Matlab, and run brahms_manager at the prompt. If you haven't installed BRAHMS version 0.7.1 or above before, running the BRAHMS Manager will prompt you to set your WorkingDirectory. This is a folder for temporary files, so choose something appropriate. Once this is done, you can close brahms_manager again.


You can now run the full test suite, brahms_test all, from Matlab. If everything is working correctly, the output should look like this:

Matlab Console
>> brahms_test all ________________________________________________ brahms_test "source" 1 result fields validated OK ________________________________________________ ...
  • If you do not use MPI (that is, if you don't have it installed or turned on), this test will fail at "source.m". This is fine, so long as you don't want to use MPI - if you do, see the Advanced Install section.