gemseo-matlab

gemseo-matlab

Overview

MATLAB wrapper for GEMSEO

Installation

!!! warning

This plugin 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:

| Python | Matlab | matlabengine |
|:------:|:------:|:------------:|
| 3.9 | r2021b | 9.11.23 |
| 3.9 | r2022a | 9.12.21 |
| 3.9, 3.10 | r2022b | 9.13.11 |
| 3.9, 3.10 | r2023a | 9.14.7 |

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`.

Install the latest stable version with pip install gemseo-matlab.

Install the development version with pip install gemseo-matlab@git+https://gitlab.com/gemseo/dev/gemseo-matlab.git@develop.

See pip for more information.

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 and questions

Please use the gitlab issue tracker to submit bugs or questions.

Contributing

See the contributing section of GEMSEO.

Contributors

• GEMSEO developers