Getting Started

The JCMsuite Matlab interface is placed in the sub-folder ThirdPartySupport/Matlab relative to the JCMsuite installation directory (here called JCMROOT). To use the JCMsuite Matlab interface it is required to add this path to the Matlab search path:

jcm_root = <JCMROOT> % -> set your JCMROOT installation directory
addpath(fullfile(jcm_root, 'ThirdPartySupport', 'Matlab'));

Or, when the environmental variable JCMROOT is set, e.g., on Windows:

addpath(fullfile(getenv('JCMROOT'), 'ThirdPartySupport', 'Matlab'));

Use the command jcmwave_info to check that the Matlab interface is now properly available:

jcm_root = <JCMROOT> % -> set your JCMROOT installation directory
addpath(fullfile(jcm_root, 'ThirdPartySupport', 'Matlab'));


%% call jcmwave_info to check the JCMsuite installation
jcmwave_info;

This will give details on the status of your JCMsuite installation, e.g., the JCMsuite version in use, license information and system properties such as the number of available CPU cores.

The entire Matlab interface consists of the following routines:

All routines provide detailed online help, e.g., use

help jcmwave_solve

to obtain help on jcmwave_solve.