Follow these instructions to configure your MATLAB® Parallel Server™ installation to work with Slurm, PBS Pro, OpenPBS, LSF, and TORQUE using built-in cluster types.
You can create a cluster profile using either a built-in cluster type or
Generic. As a best practice, use built-in cluster types where
You must use a
Generic cluster profile when:
You connect to a cluster that does not have a built-in cluster type
The MATLAB client and the cluster nodes do not have a shared file system
The MATLAB client machine is unable to directly submit jobs to the third-party scheduler, or
You need to fully customize how parallel jobs are submitted to the cluster
To configure a cluster using the
Generic cluster type, see Configure Using the Generic Scheduler Interface.
This procedure verifies that the parallel computing products are installed and configured correctly on your cluster.
In this step you create a cluster profile to use in subsequent steps.
Start the Cluster Profile Manager. On the Home tab, in the Environment area, select Parallel > Create and Manage Clusters.
Create a new profile in the Cluster Profile Manager by selecting Add Cluster Profile > LSF (or Slurm, PBS Pro or Torque, as appropriate).
With the new profile selected in the list, click Rename and edit the profile name to be
InstallTest. Press Enter.
In the Properties tab, provide settings for the following fields:
Set the Description field to
For testing installation.
Set the JobStorageLocation to the location where you want job and task data to be stored (accessible to all the worker machines if you have a shared file system).
JobStorageLocation should not be
shared by parallel computing products running different
versions; each version on your cluster should have its
Set the NumWorkers field to the number of workers you want to run the validation tests on, within the limitation of your licensing.
Set the ClusterMatlabRoot to the installation location of the MATLAB to be executed by the worker machines.
Set the SubmitArguments to include any additional command arguments required by your particular cluster and scheduler.
If you are using LSF®, set the OperatingSystem to the operating system of your worker machines.
Set HasSharedFilesystem to indicate if client and workers can share the same data location.
The dialog box should look something like this, or slightly different for Slurm, PBS Pro®, OpenPBS, or TORQUE schedulers.
Click Done to save your cluster profile.
In this step you verify your cluster profile, and thereby your installation.
You can specify the number of workers to use when validating your profile. If
you do not specify the number of workers in the Validation tab, then the validation will attempt to use as many
workers as the value specified by the
on the Properties tab. You can specify a
smaller number of workers to validate your configuration without occupying the
If it is not already open, start the Cluster Profile Manager from the MATLAB desktop. On the Home tab, in the Environment area, select Parallel > Create and Manage Clusters.
Select your cluster profile in the listing.
Click Validation tab.
Use the checkboxes to choose all tests, or a subset of the validation stages, and specify the number of workers to use when validating your profile.
The Validation Results tab shows the output. The following figure shows the results of a profile that passed all validation tests.
If your validation does not pass, contact the MathWorks install support team.
If your validation passed, you now have a valid profile that you can use in
other parallel applications. You can make any modifications to your profile
appropriate for your applications, such as
To save your profile for other users, select the profile and click Export, then save your profile to a file in a convenient location. Later, when running the Cluster Profile Manager, other users can import your profile by clicking Import.
If your cluster is already set up to use mpiexec and smpd, you can use Parallel Computing Toolbox™ software with your existing configuration if you are using a
compatible MPI implementation library (as defined in
However, if you do not have mpiexec on your cluster and you want to use it, you can
use the mpiexec software shipped with the parallel computing products.
For further information about mpiexec and smpd, see the MPICH home page. For user’s guides and installation instructions on that page, select Documentation > User Docs.
In the following instructions,
matlabroot refers to the
MATLAB installation location.
To use mpiexec to distribute a job, the smpd service must be running on all nodes that will be used for running MATLAB workers.
smpd executable does not support running from a mapped
drive. Use either a local installation, or the full UNC path name to the
Windows Vista™ does not support the
smpd executable on network
share installations, so with Vista the installation must be local.
Log in as a user with administrator privileges.
Start smpd by typing in a DOS command window:
This command installs the service and starts it. As long as the service remains installed, it will start each time the node boots.
If this is a worker machine and you did not run the installer on it to install MATLAB Parallel Server software (for example, if you are running MATLAB Parallel Server software from a shared installation), execute the following command in a DOS command window.
This command installs the Microsoft run-time libraries needed for running jobs with your scheduler.
If you are using Windows® firewalls on your cluster nodes, execute the following in a DOS command window.
This command adds MATLAB as an allowed program. If you are using other firewalls, you must configure them to make similar accommodation.
Log in as the user who will be submitting jobs for execution on this node.
Register this user to use mpiexec by typing:
Repeat steps 5–6 for all users who will run jobs on this machine.
Repeat all these steps on all Windows nodes in your cluster.
If you are using Windows firewalls on your cluster nodes,
Log in as a user with administrative privileges.
Execute the following in a DOS command window.
This command adds MATLAB as an allowed program. If you are using other firewalls, you must configure them for similar accommodation.