MATLAB wrapper for GEMSEO

Documentation

Currently, the documentation of this plugin is available via the documentation of GEMSEO.

Installation

Executing a MATLAB discipline requires that a MATLAB engine as well as its Python API are installed. The MATLAB Python API is not defined as a dependency of this package, because until MATLAB release R2020b there was no package available in PyPI. It shall be installed in the same environment as the one in which this plugin is installed, please refer to the MATLAB documentation for further information.

Here are the current versions of the MATLAB Python packages per MATLAB versions:

To make sure that MATLAB works fine through the Python API, start a Python interpreter and check that there is no error when executing import matlab.

Development

For testing with tox, set the environment variable MATLAB_PIP_REQ_SPEC to point to the URL or path of a pip installable version of the MATLAB Python API, with eventually a conditional dependency on the Python version:

export MATLAB_PIP_REQ_SPEC="matlabengine==X.Y.Z"

Docker

To create or update the podman/docker images for testing the plugin, adapt with the proper version of matlab:

podman build Dockerfile -t gemseo-matlab:r2020b --build-arg=MATLAB_VERSION=r2020b

Bugs/Questions

Please use the gitlab issue tracker at https://gitlab.com/gemseo/dev/gemseo-matlab/-/issues to submit bugs or questions.

License

The gemseo-matlab source code is distributed under the GNU LGPL v3.0 license. A copy of it can be found in the LICENSE.txt file. The GNU LGPL v3.0 license is an exception to the GNU GPL v3.0 license. A copy of the GNU GPL v3.0 license can be found in the LICENSES folder.

The gemseo-matlab examples are distributed under the BSD 0-Clause, a permissive license that allows to copy paste the code of examples without preserving the copyright mentions.

The gemseo-matlab documentation is distributed under the CC BY-SA 4.0 license.

The gemseo-matlab product depends on other software which have various licenses. The list of dependencies with their licenses is given in the CREDITS.md file.

Contributors

• GEMSEO developers