matlab_interface.md

MATLAB interface

We have made an interface so you can use SPLINTER through MATLAB. If you follow the instructions provided below you should be good to go in a matter of minutes (unless you choose to compile the library yourself).

Setup

First, head to the releases tab and download a copy of splinter-matlab. Or, you can compile the library for yourself (as described in the documentation). After doing the step make install, you should have a directory structure that looks like this:

• main

  • lib
    • windows
      • x86
        • splinter-x-y.dll
      • x86-64
        • splinter-x-y.dll
    • linux
      • x86-64
        • libsplinter-x-y.so
    • osx
      • x86-64
        • libsplinter-x-y.so
  • include
    • cinterface.h
  • matlab
    • All files from the matlab directory in the repository

• Note that you only need the folders that correspond to your platform.

• 32 bit MATLAB only exist on Windows.

• The numbers in the filename (x-y) corresponds to the SPLINTER version, where x is the major and y is the minor version.

Run setup() (defined in setup.m), which should load SPLINTER for you automatically. You must run this once for each time you start MATLAB.

Basic usage

See matlab/examples for examples on how to use SPLINTER through the MATLAB interface.

Please consult the documentation for the C++ version of the library if you still have unanswered questions after reading this document.