Bindings guidelines

The APIs for the scripting languages behaves in the same way as the Python and C++ ones. Please refer to the Python documentation and examples to learn how to use the API that will be found under the same MClientAPI and MTemplateAPI namespaces.

When using the Muster API you must configure your PATH environmental variables on Windows, and the LD_LIBRARY_PATH and DYLD_LIBRARY_PATH on posix platforms to let the API find the Muster .DLL/so files . You'll also need to set the MUSTER environmental variable to the Muster 8 root installation path, this allows the .LIB to find the python installation related to Muster. Don't forget to configure the environmental variables, because, you may end up loading another python installation laying somewhere on your filesystem and this could lead to module import errors very hard to sort out.

A typical example configuration for Window is:

MUSTER=C:\program files\virtual vertex\muster8
PATH=%MUSTER%;%PATH%

A typical example configuration on Linux is:

MUSTER=/usr/local/muster8
LD_LIBRARY_PATH=/usr/local/muster8:$LD_LIBRARY_PATH
export MUSTER
export LD_LIBRARY_PATH

A typical example configuration on Mac is:

MUSTER=/Applications/Muster8/Contents
DYLD_LIBRARY_PATH=/Applications/Muster8/Contents/Frameworks:$DYLD_LIBRARY_PATH
export MUSTER
export DYLD_LIBRARY_PATH

Due to namespaces differences, the API exposed under the scripting languages is inside the MClientAPI namespace (instead of MClientLib).

After configuring your environment, follow the instruction for the scripting engine you would like to use.