Skip to content

Commit

Permalink
MATLAB readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
@varunagrawal
varunagrawal committed Sep 26, 2020
1 parent 9bdcd2c commit ff9dc99
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions matlab/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ http://borg.cc.gatech.edu/projects/gtsam

This is the GTSAM MATLAB toolbox, a MATLAB wrapper around the GTSAM C++ library. To build it, enable `GTSAM_INSTALL_MATLAB_TOOLBOX=ON` in CMake.

The interface to the toolbox is generated automatically by the wrap
tool which directly parses C++ header files. The tool generates matlab proxy objects together with all the native functions for wrapping and unwrapping scalar and non scalar types and objects. The interface generated by the wrap tool also redirects the standard output stream (cout) to matlab's console.
The interface to the toolbox is generated automatically by the wrap tool which directly parses C++ header files.
The tool generates matlab proxy objects together with all the native functions for wrapping and unwrapping scalar and non scalar types and objects.
The interface generated by the wrap tool also redirects the standard output stream (cout) to matlab's console.

## Ubuntu

If you have a newer Ubuntu system (later than 10.04), you must make a small modification to your MATLAB installation, due to MATLAB being distributed with an old version of the C++ standard library. Delete or rename all files starting with `libstdc++` in your MATLAB installation directory, in paths:

/usr/local/MATLAB/[version]/sys/os/[system]/
/usr/local/MATLAB/[version]/bin/[system]/
If you have a newer Ubuntu system (later than 10.04), you must make a small modification to your MATLAB installation, due to MATLAB being distributed with an old version of the C++ standard library. Delete or rename all files starting with `libstdc++` in your MATLAB installation directory, in paths:

/usr/local/MATLAB/[version]/sys/os/[system]/
/usr/local/MATLAB/[version]/bin/[system]/

## Adding the toolbox to your MATLAB path

Expand All @@ -37,25 +37,28 @@ export LD_LIBRARY_PATH=<install-path>/gtsam:$LD_LIBRARY_PATH

### Linker issues

If you compile the MATLAB toolbox and everything compiles smoothly, but when you run any MATLAB script, you get following error messages in MATLAB
If you compile the MATLAB toolbox and everything compiles smoothly, but when you run any MATLAB script, you get any of the following error messages in MATLAB

```
Invalid MEX-file '/usr/local/gtsam_toolbox/gtsam_wrapper.mexa64':
Missing symbol 'mexAtExit' required by '/usr/local/gtsam_toolbox/gtsam_wrapper.mexa64'
Missing symbol 'mexCallMATLABWithObject' required by '/usr/local/gtsam_toolbox/gtsam_wrapper.mexa64'
...
```

run following shell line

```sh
export LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libstdc++.so.6
```
before you run MATLAB from the same shell.

This mainly happens if you have GCC >= 5 and newer version MATLAB like R2017a.
before you run MATLAB from the same shell.

This mainly happens if you have GCC >= 5 and newer version MATLAB like R2017a.

## Trying out the examples

The examples are located in the 'gtsam_examples' subfolder. You may either run them individually at the MATLAB command line, or open the GTSAM example GUI by running 'gtsamExamples'. Example:
The examples are located in the 'gtsam_examples' subfolder. You may either run them individually at the MATLAB command line, or open the GTSAM example GUI by running 'gtsamExamples'. Example:

```matlab
>> cd /Users/yourname/toolbox % Change to wherever you installed the toolbox
Expand All @@ -65,7 +68,7 @@ The examples are located in the 'gtsam_examples' subfolder. You may either run

## Running the unit tests

The GTSAM MATLAB toolbox also has a small set of unit tests located in the gtsam_tests directory. Example:
The GTSAM MATLAB toolbox also has a small set of unit tests located in the gtsam_tests directory. Example:

```matlab
>> cd /Users/yourname/toolbox % Change to wherever you installed the toolbox
Expand All @@ -86,4 +89,4 @@ Tests complete!

## Writing your own code

Coding for the GTSAM MATLAB toolbox is straightforward and very fast once you understand a few basic concepts! Please see the manual to get started.
Coding for the GTSAM MATLAB toolbox is straightforward and very fast once you understand a few basic concepts! Please see the manual to get started.

0 comments on commit ff9dc99

Please sign in to comment.