jcmwave_startup.mΒΆ

Usage: jcmwave_startup(), or
       jcmwave_startup(jcm_root), or
       jcmwave_startup(args)

Purpose: Deploys JCMsuite.

Input:
  'jcm_root' denotes the root installation directory of JCMsuite. When
  not set, the environment variable <JCMROOT> is used.

  args is a structure or a key-value list with the
  following optional parameters:
     args.jcm_root -> as above
     args.num_threads -> sets number of threads used by JCMsuite (calls
                         jcmwave_set_num_threads.m)
     args.tempdir   -> sets the location where temporary projects are placed instead
                       of the system's default tempdir location

Examples:
  (1) Read installation path from environmental variable <JCMROOT>:
        jcmwave_startup()

  (2) Setting jcm_root to your installation path (windows):
        jcmwave_startup('C:\Programs\JCMsuite')
      ,or
        jcmwave_startup('jcm_root', 'C:\Programs\JCMsuite')

  (3) ... additionally set number of threads

      jcmwave_startup('jcm_root', 'C:\Programs\JCMsuite', ...
                       'num_threads', 1)